Page 2 : 13
Object-oriented Programming in C#
Documentation of Object-oriented Programs
* Documentation of Object-oriented Programs
Program Documentation
Program Documentation - When and Where?
Documentation of C# Programs
A documentation example in C#
The XML Documentation Language for C#
Tool support: The C# Compiler
Tool support: Doxygen
Tool support: Other possibilities
Another documentation example in C#
Conclusion - Documentation of C# Programs
* Project Recommendations
Documentation Recommendations
Program Documentation
Documentation may serve several different purposes
User and usage documentation
Describes how the program is used
Oriented towards the end-user of the program
Documentation of types - for external purposes
Describes external properties of each type
Oriented towards programmers of client types
Documentation of programs or types - for internal purposes
Describes internal properties of a program or type
Oriented towards current and future developers of the current program or type