Viele Sprachen unterstützen Dokumentationskommentare , um einen Generator (wie javadocoder Sauerstoff) zu ermöglichen ) durch Parsen desselben Codes generieren kann. Hat Swift eine solche
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...
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 ==...
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...
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...