From a discussion on the WikiWikiWeb about the code being documentation:
Also, the code is preferable to other documentation forms, because it is known to match the code. Other forms of documentation generally require checking against the code, because they often don't match. --DougKingAn excellent statement. Many times developers check the code... not to see what it is supposed to do, but to actually find out what it does.
Yah, well, there's the rub, eh? Why do some folks insist that the code is "right," even if it disagrees with the docs? If a design doc says that two modules have such-and-such an interface and some hacker makes his blessed code do something different, then the code is wrong. This business of going back to "correct" the docs after the code has been hacked out is wrong-headed.
The code may not be "right", but it is true.
No comments:
Post a Comment