Theme index -- Keyboard shortcut: 'u'  Previous theme in this lecture -- Keyboard shortcut: 'p'  Next slide in this lecture -- Keyboard shortcut: 'n'Documentation of Object-oriented Programs

A complete PDF version of the text book is now available. The PDF version is an almost complete subset of the HTML version (where only a few, long program listings have been removed). See here.

57.  Project Recommendations

 

57.1.  Documentation Recommendations
Contents   Up Previous Next   Slide Annotated slide Aggregated slides    Subject index Program index Exercise index 

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

Generated: Monday February 7, 2011, 12:24:12
Theme index -- Keyboard shortcut: 'u'  Previous theme in this lecture -- Keyboard shortcut: 'p'  Next slide in this lecture -- Keyboard shortcut: 'n'