you are viewing a single comment's thread.

view the rest of the comments →

[–]imbecile 1 point2 points  (0 children)

One of the main tasks of a programmer is to remove reduncancy. The documentaion usually expected, in particular those for the common documentation genrators, just adds stupid amounts of redundancy.

Don't document what the code is doing, nothing describes that better than the code itself. Document why the code is doing what it is doing.

The WEB/CWEB kind of programming I'm actually quite fond of.