Lecture overview -- Keyboard shortcut: 'u'  Previous page: Another documentation example in C# -- Keyboard shortcut: 'p'  Next page: Project Recommendations [Section] -- Keyboard shortcut: 'n'  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 11 : 13
Object-oriented Programming in C#
Documentation of Object-oriented Programs
Conclusion - Documentation of C# Programs

  • XML Comments in C# programs

    • In principle a good idea

    • The XML documentation repertoire is not comprehensive

    • Voluminous

  • The generated XML documentation file

    • In principle a good idea

    • Should have been self-contained and complete

    • Should "automatically" be translated to good HTML documentation

Microsoft's C# documentation facilities are complicated to use, rudimentary, and of poor quality

Does not meet the standards of C# as such

Far away from the quality of Javadoc from Sun