Lecture overview -- Keyboard shortcut: 'u'  Previous page: Documentation of Object-oriented Programs [Section] -- Keyboard shortcut: 'p'  Next page: Program Documentation - When and Where? -- 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 2 : 13
Object-oriented Programming in C#
Documentation of Object-oriented Programs
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