2 ms·
My personal documentation guideline is, just answer the five W questions: * What it does: The code answers this in a clear manner * Who: did it, the code repo
by elviejo 8y ago
My personal documentation guideline is, just answer the five W questions:
* What it does: The code answers this in a clear manner
* Who: did it, the code repository answers this.
* Where: is used, your IDE should be able to show this
* When: was it made code repository, when is used stack traces
* Why: why does it exist? that is the only part that needs to be in a comment.
- slededit 8y agoI like to know how well the author understood the problem. Unfortunately git allows people to rewrite history and hide the guess+check process many go through.