5 ms·
>As I’m going through all of this code, I’m hoping to start documenting the classes I go through here and explain what’s going on. YES. One of my biggest prod
by pm90 13y ago
>As I’m going through all of this code, I’m hoping to start documenting the classes I go through here and explain what’s going on.
YES.
One of my biggest productivity boosters when dealing with understanding code written by others was to use Evernote to document all my ideas, theories of how the code worked, tests to see if it really did work that way and final result. By documenting everything, I can at least rule out theories that don't work; I think this is at least part of what is known as the scientific method.
I hope this becomes a trend and many more people start documenting their findings. Let google loose on all that data and you save thousands of man-hours spent understanding code
- toomuchtodo 13y agoComments in code is a start. URLs to documentation in comments is better.
- philsnow 13y agodepends. when the code changes, how do you enforce that the documentation changes, and that they change in sync? depending on how you're storing the documentation off to the side, do you have two versioning schemes to reconcile when trying to look at code history? does you documentation even ha e versioning? if you keep the docs in the repo, during code review you can say "hey, update the doc while you're at it" or "this doc change doesn't agree with this code change, can you take another look at it?"