| Version 1.9 Build 803
|
|
Next: Names for Classes, Functions and Variables
Up: Documentation and Naming
Previous: Documentation in Header Files
Background, usage, and overall design is presented in class header files,
and implementation files do not need to repeat them. But non-obvious
sections of code do need to be accompanied by explanation, including
references to manuals or texts as appropriate. ``Obvious'' is to be
judged from the perspective of a competent programmer, generally
knowledgeable - but not necessarily expert - in the program domain. The
guiding principle is: do not force those who read your code to spend
unnecessary time deciphering it. It will always be a net savings
of time if you document what you have done, and why you did it.
Next: Names for Classes, Functions and Variables
Up: Documentation and Naming
Previous: Documentation in Header Files
Contents
Index
Please send questions or comments about AIPS++ to aips2-request@nrao.edu.
Copyright © 1995-2000 Associated Universities Inc.,
Washington, D.C.
Return to AIPS++ Home Page
2004-08-30
News