Dokumentation

D möchte wichtige Bereiche moderner Softwareentwicklung in die Sprache integrieren. Neben Contract Programming und Unittests bietet D nativ die Erzeugung einer Quellcode-Dokumentation an.

Für die Dokumentation von Typen und Funktionen wird ein Standard-Schema angewendet. Der Befehl dmd -D erstellt auf bequeme Art eine HTML-Dokumentation anhand der in der Kommandozeile übergebenen Quelldateien. Tatsächlich wird die komplette Phobos Bibliotheks-Dokumentation mit DDoc generiert.

Die fogenden Kommentarstile werden von DDoc für die Einbindung in die Quellcode-Dokumentation berücksichtigt:

  • /// Drei Slashes vor Typ bzw. Funktion
  • /++ Mehrzeiliger Kommentar mit zwei + +/
  • /** Mehrzeiliger Kommentar mit zwei * */

Der Beispielquellcode zeigt einige standartisierte Dokumentationsabschnitte.

Weiterführende Quellen

rdmd playground.d