Difference between revisions of "Cpp Coding Standards/CODEDOC"
From Apache OpenOffice Wiki
m (Fixed category.) |
m (Cpp Coding Standards/Code Documentation moved to Cpp Coding Standards/CODEDOC: consistency) |
(No difference)
| |
Revision as of 13:54, 22 May 2007
Topic-Id: CODEDOCU
How to document code. There are two kinds of code comments:
- Interface documentation to be extracted from a documentation tool. This here is called “documentation”.
- Comments between code lines. Those are called “comments” here.
Contents
Summary
Describe the Class Responsibility (ClassResp)
Start the documentation of each class with a concise statement about its responsibility.
Clarify Function Behaviour (ClearBehave)
In function documentation, do document, when any of the pre- or postconditions of a function is not unambiguously clear. Document, when the behavior in error cases is unclear.
Do not comment the obvious. Do not repeat information that is in the function name or parameter types or names. There may well be functions that need no further documentation.
Format (Format)
In documentation, adhere to the documentation tags and format as described in the code documentation HowTo.
