documentation-generation

63Hitze

2Antwort

Wie kann ich JSDoc über die Struktur eines Objekts informieren, das zurückgegeben wird. Ich habe die @return {{field1: type, field2: type, ...}} description Syntax gefunden und versuchte es: /** * Re

8Hitze

1Antwort

Verwenden von Dub zum Erstellen von Dokumentation

Wie verwende ich Dub, um DDocs aus meinen Quelldateien zu erstellen? Es scheint keinen Standard-Befehl in Dub zu geben, um dies zu tun, und ich würde wirklich gerne in der Lage sein, diesen Prozess zu

19Hitze

3Antwort

Wie kann Matworks HTML-Dokumentation mit Mathworks generiert werden?

Ich arbeite an gemeinsamem Matlab-Code und möchte eine generierte Dokumentation als durchsuchbare HTML-Dokumente in unserem lokalen Netzwerk teilen. Ich kenne die folgenden Methoden, um eine Dokumenta

7Hitze

1Antwort

Warum ist Doxygen so unfreundlich zu Handys?

Doxygen scheint die erste Wahl für Codedokumentation in C++ (und vielen anderen Sprachen) zu sein, aber jedes Mal, wenn ich Doxygen doc von meinem Handy suche, scrollt die Seite leider nicht, der Text

5Hitze

1Antwort

Wie dokumentiere ich ein Array mit Subarrays (gemischter Typ)?

Um eine Variable zu dokumentieren, die eine Anordnung annehmen können, die einen Vektor, dessen Wert strings empfängt: /* * @var string[] An array of string objects. */ $foo = array('A', 'B', 'C');

8Hitze

2Antwort

Kann Sphinx Napoleon Dokument Funktion mehrere Argumente zurückgeben?

Ich versuche, den Google-Code-Stil zu verwenden, um eine Funktion zu dokumentieren, die ich dann sphinx mit der Napoleon-Erweiterung verwende, um Dokumentation für zu erstellen. Die Funktion ist insof

14Hitze

4Antwort

Erstellen von HTML-Dokument aus Postbote Sammlung

Ich habe eine ziemlich umfangreiche API entwickelt, und ich habe es auf Postman, die ziemlich gut funktioniert. Jetzt muss ich ein HTML-Dokument erstellen, um es versioniert in/Docs zusammen mit meine

8Hitze

1Antwort

Welcher Dokumentationsgenerator wird für lodash.com verwendet?

Irgendwelche Ideen, was ist der von verwendete Dokumentationsgenerator? Ich habe mich in ihrer Dokumentation umgesehen und google benutzt und kann nichts finden. Ich möchte einen ähnlichen Dokumentati

16Hitze

2Antwort

Wie funktioniert das Doxygen Plugin in Android Studio?

Ich muss ein Dokument für meine App in Android Studio erstellen. Ich habe bereits Dokumente mit Doxygen in Eclipse erstellt, aber ich weiß nicht, wie man Doxygen in Android Studio benutzt, um automati

6Hitze

1Antwort

automatisch Yard Doc Skelette zu bestehenden Rails Legacy-Code hinzufügen

Ich würde gerne Templates YARD Doc Style Kommentare in meine vorhandene Rails Legacy-Anwendung einfügen. Derzeit hat es wenige Kommentare. Ich möchte Klassenheader und Methodenheader, die die Paramete