3 ms·
I'm not sure this is a good direction. We all want better documentation, but the problem with comments is that they can lie.
by namuol 14y ago
I'm not sure this is a good direction.
We all want better documentation, but the problem with comments is that they can lie.
- libria 14y agoCommenting is still not required, AFAICT. Are you positing that better formatting encourages worse comments/documentation? I'm of the opinion that their presentation is independent of their quality.
- namuol 14y agoI fear that emphasis of documentation, to this extent, encourages us to read comments first and foremost, rather than the code. I realize that the emphasis could be perceived the other way around (on the code, rather than the comments), but the author's intention seems to be the other way around.
- lallysingh 14y agoCode review -- look for an equal diff in the docs with the source. No code review? Bigger problems.