Lecture overview -- Keyboard shortcut: 'u'  Previous page: The elucidative programming model -- Keyboard shortcut: 'p'  Next page: The source format of the documentation - Java -- Keyboard shortcut: 'n'  Lecture notes - all slides and notes together  slide -- Keyboard shortcut: 't'  Help page about these notes  Alphabetic index  Course home  Page 26 : 47
Elucidative Programming
The source format of the documentation - Scheme

When the programmer works with a literate program the source format of the documentation is of particular interest. This format is important because it constitute the words and lines actually written by the programmer. In addition, the programmer will spend much time reading parts of the documentation in this format. Therefore the properties of the format matters. This page is related to the Scheme elucidator only.

A simple, specialized markup is used for the overall structure, the relations, and the source markers

HTML is used for additional markup purposes

  • Observations about the source format of the documentation

    • Non-obstructive, discrete, and terse

      • at least compared with XML-like markup

    • It is relatively easy and attractive to read the documentation in the editor

    • The supplementary use of HTML is in line with the choice in JavaDoc

      • Avoids proliferation of languages with similar purposes

      • The mixing of markup styles is not aesthetically pleasant