Programmierung documentation-generation

12

Hat Swift Unterstützung bei der Generierung von Dokumentationen?

Viele Sprachen unterstützen Dokumentationskommentare , um einen Generator (wie javadocoder Sauerstoff) zu ermöglichen ) durch Parsen desselben Codes generieren kann. Hat Swift eine solche Dokumentationskommentarfunktion?

238 swift documentation-generation

3

JSDoc: Objektstruktur zurückgeben

Wie kann ich JSDoc über die Struktur eines zurückgegebenen Objekts informieren? Ich habe die @return {{field1: type, field2: type, ...}} descriptionSyntax gefunden und ausprobiert: /** * Returns a coordinate from a given mouse or touch event * @param {TouchEvent|MouseEvent|jQuery.Event} e * A valid mouse or touch event or a jQuery …

143 javascript documentation-generation jsdoc code-documentation jsdoc3

8

Wie dokumentiere ich eine Methode mit Parametern?

Wie dokumentiere ich Methoden mit Parametern mithilfe der Python-Dokumentationszeichenfolgen? EDIT: PEP 257 gibt dieses Beispiel: def complex(real=0.0, imag=0.0): """Form a complex number. Keyword arguments: real -- the real part (default 0.0) imag -- the imaginary part (default 0.0) """ if imag == 0.0 and real == 0.0: return complex_zero ... …

139 python documentation documentation-generation

3

Objective-C-Dokumentationsgeneratoren: HeaderDoc vs. Doxygen vs. AppleDoc

Ich muss eine Lösung zur Dokumentationsgenerierung für meinen Arbeitsplatz implementieren und habe sie auf die drei im Titel genannten eingegrenzt. Ich konnte nur sehr wenige Informationen über formalisierte Vergleiche zwischen diesen Lösungen finden, und ich hoffe, dass diejenigen von Ihnen, die Erfahrung in einem oder mehreren der oben genannten Bereiche …

74 doxygen documentation-generation headerdoc appledoc

3

Wie erstelle ich mit Pydoc Dokumentation?

Ich versuche, aus meinem Modul ein Dokument zu erstellen. Ich habe pydocüber die Befehlszeile in Windows 7 Python 3.2.3 verwendet: python "<path_to_pydoc_>\pydoc.py" -w myModule Dies führte dazu, dass meine Shell mit Text gefüllt wurde, einer Zeile für jede Datei in meinem Modul, in der stand: no Python documentation found for …

74 python documentation python-3.x documentation-generation pydoc

Als «documentation-generation» getaggte Fragen