Lecture overview -- Keyboard shortcut: 'u'  Previous page: The meaning of the word -- Keyboard shortcut: 'p'  Next page: Requirements -- Keyboard shortcut: 'n'  Lecture notes - all slides and notes together  slide -- Keyboard shortcut: 't'  Help page about these notes  Alphabetic index  Course home  Page 20 : 47
Elucidative Programming
Elucidative Programming

At this place we introduce elucidative programming. We here describe a number of key properties of the documentation approach.

Elucidative programming is meant to be a variant of literate programming for prevenient program comprehension which remedies some of the identified problems with literate programming

  • Elucidative programming highlights:

    • User interface

      • Present the program and the documentation side-by-side in an Internet browser

    • Leave the program "in peace"

      • Does not impose any requirement on the organization of the program in files or directories

    • Address existing abstractions from the documentation

      • Does not rely on separately named program fragments

    • Supported by the development environment

      • Requires specialized editor functionality

We will return to all of these items later in the presentation