Documentation of Object-oriented Programs
- slide 2 : 13
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