Dokumentation in C++

Die maßgebliche (vom Hersteller der Bibliothek gelieferte) Beschreibung einer Bibliothek (API) oder eines ihrer Teile wird oft als Dokumentation  bezeichnet.

Die meisten vordefinierten Namen von C++  gehören zur C++ -Standardbibliothek.

Die Dokumentation der Standardbibliothek in der Spezifikation von C++  beschrieben und findet sich auch in vielen Lehrbüchern, Nachschlagewerken  oder Webseiten.

Dort findet man dann beispielsweise die Dokumentation des Namens »INT_MAX«.

Dokumentation von »INT_MAX« (vereinfacht und eingedeutscht)

#include <climits>
int INT_MAX;

Maximaler Wert des Datentyps »int« unter der verwendeten Implementation

Die Dokumentation gibt auch an, welche Include -Zeile am Anfang eines Programms, das den Namen im Sinne dieser Dokumentation verwenden will, benötigt wird.

Die obige Dokumentation gibt auch den Datentyp »int« dieses Namens an.

Wir bezeichnen den englischsprachigen Text am Ende als Prosa, den davorstehenden formalsprachigen Teil als Synopse, und den Teil, der am Ende der Synopse nach den Inklude-Zeilen steht als Proklamation. Der Teil der Proklamation, der beschreibt, was dokumentiert wird, ist das Lemma  der Dokumentation.

Synopse von »INT_MAX«

#include <climits>
int INT_MAX

Proklamation von »INT_MAX«

int INT_MAX;

Lemma »INT_MAX«

INT_MAX

Prosa von »INT_MAX«

Maximaler Wert des Datentyps »int« unter der verwendeten Implementation

Die Proklamation  gibt den Typ  des dokumentierten Namens und diesen Namen  selber (das Lemma) an. Ein eventuell vorhandenes Semikolon »;« am Ende der Proklamation soll nur das Ende der Proklamation kennzeichnen und hat sonst keine Bedeutung.

Die Synopse  erweitert die Proklamation noch durch die für eine Verwendung des Namens nötige(n) Einfügedirektiven.

Die Prosa  gibt in englischer Sprache (oder – übersetzt – in deutscher Sprache) alle zur Verwendung wichtigen Informationen, die man nicht schon der Synopse entnehmen kann.