good chemistry is complicated, and a little bit messy -LW |
|
PerlMonks |
Re: Preferred method of documentation?by bwelch (Curate) |
on Oct 06, 2004 at 13:11 UTC ( [id://396971]=note: print w/replies, xml ) | Need Help?? |
My rule for documentation is that I should be able to look over the code in a few years and see easily what the code does and whether all or parts of it is useful to any task at hand.
This leads me to a style similar to that of documenting new projects in sections:
One thing I try to remember is that while things may seem obvious while writing and testing the code, a year or so in the future they won't be. Commenting with that in mind has helped me out in many situations.
In Section
Meditations
|
|