documentation-generation

6Hitze

6Antwort

Welches Werkzeug/Framework für die technische Dokumentation?

Wir entwickeln Produkte und Frameworks für den Einsatz in unserer Organisation. Ich suche Programmierer-freundliche Dokumentationswerkzeuge. Ich habe einige Optionen zu einem späteren Zeitpunkt recher

5Hitze

1Antwort

Warum schlägt ocamldoc auf ungebundenen Modulen fehl?

Hier ist ein Beispiel Schnittstelle test.mli, mit ocamldoc-Stil Kommentaren kommentiert: (** ocamldoc module comment *) open MissingModule;; (** ocamldoc function comment *) val test : unit;; Wen

20Hitze

6Antwort

Wie erhalte ich eine mehrseitige Site vom automatischen Generator von GitHub Pages?

Ich benutze den 'automatischen Generator' von GitHub Pages, und ich sehe, es erzeugt nur eine einzige index.html und andere Web-Ressourcen. Wie funktioniert es, wenn ich eine mehrseitige Website aus a

23Hitze

4Antwort

Wie api-Dokumentation zu generieren

Ich muss einige API-Dokumentation für eine REST-API schreiben, die ich erstellt habe. Gibt es Werkzeuge, die eine nette HTML-Ausgabe ausgeben, ähnlich wie die Unterstrich-API-Dokumentation? Oder viell

8Hitze

3Antwort

Appledocs Mit Dokumentation erzeugen

ich für die Einfachheit meiner Frage entschuldigen, aber ich habe versucht, Dokumentation mit Appledocs (https://github.com/tomaz/appledoc#quick-install) Ich bin nicht sicher zu erzeugen, wie genau es

26Hitze

2Antwort

Swagger mit statischer Dokumentation

Ich suche Swagger, um meine erholsame Schnittstelle zu dokumentieren. Das Problem ist, dass ich meine Dokumentation nicht automatisch generieren möchte, indem ich meinen Code annotiere. Grundsätzlich

7Hitze

2Antwort

Sphinx: Liste der unterstützten Sprachen zum Hervorheben?

Ich benutze Sphinx für Code-Dokumentation und verwenden mehrere Sprachen innerhalb des Codes, ich möchte markieren für diesen Code. Sphinx erwähnt kurz einige der Sprachen, die es unterstützt (on this

5Hitze

2Antwort

Referenzieren einer bestimmten Klassenmethode mit @see-Befehl unter Verwendung von Doxygen

Ich konnte mit dem Befehl doxygen @see nicht auf eine bestimmte Klassenmethode verweisen. Angenommen, ich habe eine Klasse-Server mit einer Methode starten wie unter @interface Server : NSObject - (

5Hitze

2Antwort

Verwendung von Doc-O-Matic (Express) mit Delphi

Ich bin auf der Suche nach einem Tool zum Erstellen von Delphi-Quellcode-Dokumentation, und ich möchte versuchen, Doc-O-Matic Express (die frei ist). Gibt es Richtlinien für Anfänger, wie man Doc-O-Ma

8Hitze

1Antwort

Dokumentation von Klassen und Modulen in YUIDocs

Ich habe ein paar Probleme mit dem Schreiben meiner Dokumentation für eine Gruppe von gruppierten Modulen. Ich denke, es ist teilweise ein Missverständnis darüber, was @class, @module und @namespace d