documentation

3Hitze

2Antwort

Dokumentieren von Angular2 TypeScript-Code

Hat jemand Ratschläge, sollte ich meinen TypeScript-Code für eine Angular2-Anwendung dokumentieren? Ich suche nach einem Werkzeug, das Dokumentationsseiten aus dokumentiertem Code generieren kann. Ich

2Hitze

1Antwort

Kann Roxygen wirklich R-Skript (kein Paket) wie Doxygen für C++?

Roxygen ist inspiriert von dem Doxygen-Dokumentationssystem, das von C, C++ - Programmierern verwendet wird. Ich habe Doxygen benutzt und finde es wirklich einfach, jedes Programm zu dokumentieren, so

0Hitze

1Antwort

C# Dokumentation/Kommentare für unveränderliche Klassen

Hallo, gibt es eine Möglichkeit, die Eigenschaften eines unveränderlichen Typs für einen Entwickler in C# zu dokumentieren? Ich weiß, dass Sie leicht Klassen dokumentieren können und Objekte selbst mi

1Hitze

2Antwort

MATLAB-Klassendokumentation in HTML veröffentlichen

Ich erstelle ein MATLAB-Paket mit objektorientierter Programmierung. Ich habe meine Klassen nach einer tutorial von MathWorks Website dokumentiert. Dieser Standard der Dokumentation funktioniert jedoc

1Hitze

1Antwort

Suche nach Sphinx-Dokumentengenerator funktioniert nicht

Ich erstelle ein Dokument mit dem SPHINX-Dokumentgenerator. Ich habe dem Dokument viele Einträge erfolgreich hinzugefügt. Mein Problem ist die Suche nach diesen ganzen Dingen. Wenn ich nach einem Wort

1Hitze

1Antwort

Dokument, das YARD den Rückgabetyp einer Instanzmethode verwendet, die die Instanz der Klasse

zurückgibt. Ich konnte dies nirgendwo finden, einschließlich der Yard-Dokumentation. Ich möchte den Rückgabetyp einer Instanzmethode dokumentieren. Zum Beispiel class Foo def initialize end

0Hitze

1Antwort

Wie man nur einen Teil eines Dokuments in Godocs anzeigen kann

Ich verwende Godocs, um meine in go/golang geschriebene API zu dokumentieren, und dokumentiere sie mit godocs in dem Sinne, dass ich eine HTML-Seite meiner gesamten Hauptdatei erzeuge. Go-Datei, die a

0Hitze

2Antwort

Python beste Möglichkeit, importierte Modulversion in Skripten zu dokumentieren

Was ist der beste Weg oder PEP-Konvention, um die Versionen von importierten Modulen in einzelnen Python-Skripten zu dokumentieren? Manchmal muss ich ältere Skripte benutzen, die wegen Modulinkompatib

3Hitze

1Antwort

UML-Klassendiagramm für PHP-Site ohne Klasse

Ich versuche, UML-Dokumentation für PHP-Site zu erstellen. Ja, ich weiß, das ist nicht der übliche Weg - aber diese Seite ist bereits in Produktion und jetzt brauchen wir UML-Dokumentation :) Programm

2Hitze

1Antwort

AngularJS Dokumente - wie werden sie generiert?

Die AngularJS documentation ist klar und einfach zu lesen - wie wird es erzeugt? Wenn JSDoc verwendet wird, ist das Stylesheet verfügbar?