General ⇒ Documenting on code revisions
-
- Posts: 1
- Joined: Wed Dec 10, 2014 12:39 pm
Documenting on code revisions
Since there are quite a lot of lines of code that have changed, it is not really an option to go through all of them manually, copy and paste relevant bits and add commentary.
My questions are:
How would you go about making such a document, preferably with colors or some markup to clearly show differences?
Would you show the code versions side by side, or rather show a kind of diff log?
Where would you add commentary?
I am thinking of using the terminal git diff color output as a basis, somehow getting LaTeX to typeset this and adding in my comments.
Learn LaTeX easily with newest books:
The LaTeX Beginner's Guide: 2nd edition and perfect for students writing a thesis
The LaTeX Cookbook: 2nd edition full of practical examples for mathematics, physics, chemistry, and more
LaTeX Graphics with TikZ: the first book about TikZ for perfect drawings in your LaTeX thesis