Lecture overview
Keyboard shortcut: 'u'  Previous page
Keyboard shortcut: 'p'  Next page
Keyboard shortcut: 'n'  Lecture notes - all slides and notes together  slide
Keyboard shortcut: 't'  Help page about these notes  Alphabetic index  Course home  Slide 5 : 38
Integrated program documentation

We will here explore the possibilities of integrating programs and written program documentation

There are several ways to integrate program and documentation

  • The documentation is embedded in the program

    • Conventional program comments

    • The program is the main structure

  • The program is embedded in the documentation

    • Literate programming

    • The documentation is the main structure

  • The program and the documentation are separated, but connected via links

    • Hypertext approach

    • The starting point of elucidative programming