Documentation of Object-oriented Programs
- slide 13 : 13
Documentation Recommendations
Recommendations for program documentation in your project
Use of Doxygen
Document the client interfaces of
all types (all classes)
in your project
Deliver the documentation as an
electronic enclosure
Arrange that the documentation is linked to a
clean version
the actual source program
Linked to source program
: Expert > Source Browser: SOURCE_BROWSER.
Clean version
: Expert > Source Browser: STRIP_CODE_COMMENTS
The documentation should not be written as a last minute effort
It is useful for fellow programmers during the project
The generated type documentation is a much more attractive entry point to your code than the raw source files
![Previous page: Project Recommendations [Section] -- Keyboard shortcut: 'p'](./images/nav-left.gif "Previous page: Project Recommendations [Section] -- Keyboard shortcut: 'p'")
