by Guy Macon <http://www.guymacon.com/>
Mar 15, 2008 at 09:17 PM
Bernd Paysan wrote:
>I'm all for good do***entation, but the most useful do***entation
>is *not* the one that explains in English what the programming
>language statement [to the left of it] is going to do.
Years ago I worked at a place that encouraged non-programmer
management to learn to write at least a little code so as to
better understand what software can and can not do. This one
manager kept insisting on putting in comments explaining what
each statement did, with very little indication of what the
routines or even the whole program do. Comments like "add
content of Register X to Ac***ulator"...
One of the developers wrote him an autocommenter program
that did it for him, and would also remove the comments
it had added without touching any other comments.