Re:Your Code is Not Self Documenting
by lelele on Monday January 10, 2011 @04:57AM
(#2087994)
> Comments are for explaining why.
Awesome. I'd add "why not" as well, that is: why you discarded some alternative solution? That's very important especially when refactoring is involved. Some programmer could come by and think: "Why she didn't just do like this? It would have been much easier."
I find that explanations about discarded solutions is (almost) always missing from both comments and higher-level documents.
Awesome. I'd add "why not" as well, that is: why you discarded some alternative solution? That's very important especially when refactoring is involved. Some programmer could come by and think: "Why she didn't just do like this? It would have been much easier."
I find that explanations about discarded solutions is (almost) always missing from both comments and higher-level documents.