[Novalug] documentation
Ed James
edjames at greenbelt.com
Thu Apr 17 18:32:12 EDT 2008
I agree, with a small twist. Long ago, I started doing the
comments first, to make sure I understood what I wanted to
do, and to make sure the logic was sound. This was particularly
handy when I was new to a given language. After that, the code
pretty much just fell into place. Development was thusly made
easier.
On the maintenance side, having accurate comments really make
doing enchancements a lot easier, rather than flicking back and
forth between code and manuals.
Ed James
Quoting Gary Knott <knott at civilized.com>:
...
> In my not-so-humble opinion, the code should be carefully
> documented by using comments IN PLACE, so that the code and
> programmer's documentation goes together.
More information about the Novalug
mailing list