Lecture overview -- Keyboard shortcut: 'u'  Previous page: Project Recommendations [Section] -- Keyboard shortcut: 'p'    Lecture notes - all slides and notes together  slide -- Keyboard shortcut: 't'  Textbook -- Keyboard shortcut: 'v'  Help page about these notes  Alphabetic index  Course home  Page 13 : 13
Object-oriented Programming in C#
Documentation of Object-oriented Programs
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