Lecture overview -- Keyboard shortcut: 'u'  Previous page: Elucidative Programming -- Keyboard shortcut: 'p'  Next page: An example of an elucidative program -- Keyboard shortcut: 'n'  Lecture notes - all slides and notes together  slide -- Keyboard shortcut: 't'  Help page about these notes  Alphabetic index  Course home  Page 21 : 47
Elucidative Programming

The first paper we wrote about elucidative programming was focussed on a number of requirements. These requirements are listed on this page.

  • Target
    The internal documentation must be oriented towards current and future developers of the program

  • Purpose
    The internal documentation is intended to address explanation which serves to maintain the program understanding and to clarify the thoughts behind the program

  • Separation
    The program source file must be intact, without embedded or surrounding documentation

  • Tools
    The programmer must experience support of the program explanation task in the program editing tool

  • Chunking
    The program 'chunking structure' follows the main abstractions supported by the programming language

  • Medium
    The documented program must be available in an attractive, on-line representation suitable for exposition in an Internet browser