[Geowanking] FOSS GIS Programming Style - Different Standard For Source Code Comments
nelson at crynwr.com
Sat Feb 23 13:01:57 PST 2008
Landon Blake writes:
> Do you think there should be a different standard or policy for source
> code comments in code used in open source programs, in comparison to
> that used in proprietary programs?
No. Comment if it makes sense, and don't comment if it doesn't. It
NEVER, EVER makes sense to explain what the code does in a comment.
Comments are for explaining WHY code does what it does, or to explain
what the code does NOT do, because doing that would be wrong.
--my blog is at http://blog.russnelson.com | Software that needs
Crynwr sells support for free software | PGPok | documentation is software
521 Pleasant Valley Rd. | +1 315-323-1241 | that needs repair.
Potsdam, NY 13676-3213 | Sheepdog |
More information about the Geowanking