2 ms·
First, I think more documentation always beats less documentation, assuming reasonable quality. What the article is getting at is the idea that documentation f
by einhverfr 13y ago
First, I think more documentation always beats less documentation, assuming reasonable quality. What the article is getting at is the idea that documentation for the sake of documentation never results in any quality.
When I write a new module for LedgerSMB (I won't vouch for older code either by myself or others) I actually start writing the documentation. The reason here is that the documentation is written primarily to establish the contracts under which the code operates. This includes concept of operation documentation as well. It isn't just aimed at other programmers. It is aimed at documenting the code contracts so that it is clear what are acceptable operations at first.
So if there is a fallacy it is not that more code documentation is better (since that is often true, IMO), but rather that telling people to document for the sake of building documentation works.
- jheriko 13y ago"What the article is getting at is the idea that documentation for the sake of documentation never results in any quality." X for its own sake is rarely good.