documentation

Fügt eine Dokumentation in den aktuellen Namensraum ein oder da, wo es angegeben ist.

documentation(global)
Bis /======== ist Dokumentation. Diese Seite heißt "global" und kann mit [[global]] verlinkt werden.
  
/========

documentation(global#name)
Diese Doku ist erreichbar mit [[global#name]] oder im Namensraum global unter [[#name]]

Im Code kann auf Dokumentation verwiesen werden

a is int; see(global);

Durch das Rendern einer Doku könnte ein Handbuch gerendert werden, in dem man beispielsweise global.frontpage, global.content und dann die die verweise in global.content nacheinander einsetzt.

Remark

remark beschreibt einen Textblock, der in Wiki-Text realisiert ist und lokal in den Quelltext steht. Er ist nicht teil der Dokumentation.

see

referenziert entweder auf eine Id einer remark oder einer Dokumentation.

Vorbedingungen dokumentieren

Radius is dbl
{
  construct( .dbl )
    assert( dbl >= 0 );     // Wird als Vorbedingung gewertet und dokumentiert

  construct( .dbl )
    assert( .dbl >= 0 )      // Wird als Vorbedingung gewertet und dokumentiert
  {
    print "Radius konstruiert" );
  }

  construct( .dbl )
  {
    print "Radius konstruiert" );
    assert( .dbl >= 0 )      // Wird nicht als Vorbedingung gewertet und dokumentiert, sondern als assert innerhalb einer
                             // Berechnung
  }
}

Das kann dann automatisch in die Dokumentation geparst werden.