documentation, Seitenzahl 1

DIESER TAG IST NUR FÜR DOKUMENTGENERATOREN. Fügen Sie auch Sprache und / oder SDE-Tag hinzu. Verwenden Sie KEINE VERBINDUNGEN, um Links zu Dokumentationen oder Tools anzufordern oder die Herstellerdokumentation zu kritisieren.

Antwort

Dokumentieren von Funktionsabschlüssen

Angenommen, ich habe eine Funktion in meinem Paket geschlossen, zum Beispiel %Vor% Was ist der korrekte (in der offiziellen CRAN Sinne) Weg, diese Funktion zu dokumentieren? Insbesondere Ich möchte roxygen2 verwenden Ich möchte Do...

23.10.2012, 09:50

Antwort

HelpInsight-Dokumentation in Delphi 2007

Ich verwende D2007 und versuche, meinen Quellcode zu dokumentieren, indem ich die HelpInsight-Funktion verwende (seit D2005). Ich bin hauptsächlich daran interessiert, dass die HelpInsight-Tooltipps funktionieren. Aus verschiedenen Web-Surfen un...

10.09.2008, 00:04

Antwort

Code in Xcode 8 dokumentieren [geschlossen]

Ich habe gesehen, dass Apples HeaderDoc User Guide hat als "zurückgezogenes Dokument" mit diesem Hinweis gekennzeichnet: Wichtig: Dieses Dokument enthält möglicherweise keine Best Practices für die aktuelle Entwicklung. Links zu Download...

26.09.2016, 09:58

Antworten

Wie dokumentiert man Strukturen in Python?

Wenn erwartet wird, dass ein Argument für eine Funktion eine bestimmte (oder äquivalente) Struktur ist, die mit list , tuple und dict von python, wie und wo sollte es dokumentiert werden? Ein Beispiel Dokumentation : %Vor% Ei...

07.02.2013, 17:39

Antworten

Programmatischer Zugriff auf Java-Dokumentation [geschlossen]

Gibt es eine API, um programmatisch auf die Java-Dokumentation zuzugreifen? Ähnlich wie die Editoren / IDEs wie Eclipse für IntelliSense. Natürlich kann das von javadoc generierte html geparst und indiziert werden, aber es wäre toll zu wissen,...

12.10.2012, 22:13

Antwort

Wie man mit sphinx nur eine Datei erstellt

Für eine schnelle Vorschau möchte ich nur eine Datei und nicht das gesamte Projekt erstellen. Es ist möglich mit Sphinx? Kürzlich mache ich etwas wie: %Vor% Danke

16.08.2012, 16:54

Antworten

RTL-Unterstützung in Python Sphinx

Gibt es eine Möglichkeit, RTL-Text (von rechts nach links, wie Farsi, Arabisch, ...) in sphinx zu verwenden? Beim Generieren von HTML aus .rst-Dateien ist das generierte HTML LTR (standardmäßig von links nach rechts) und nach links ausgeric...

30.09.2012, 12:20

Antwort

Verwenden von Lint-Kommentaren mit doxygen

Für die Dokumentation müssen wir normalerweise ein zusätzliches Dokument erstellen, das beschreibt, was wir gemacht haben, als Flusennachrichten im Code (e.g. /* lint --e228) deaktiviert wurden. Es würde es viel einfacher machen, es mit doxy...

17.01.2013, 16:55

Antworten

Mehrere Sphinx-Dokumentationswebsites kombinieren [geschlossen]

Ich möchte mehrere Sphinx-generierte Dokumentationssites an einem einzigen Ort (Site) zusammenführen. Ich möchte die Arbeit nicht replizieren, sondern nur von einem zentralen Ort aus indexieren / suchen. Anforderungen : Durchsuchbare Dok...

05.09.2012, 00:18

Antwort

VS2012 Wie zeigt man Dokumentation von C ++ - Standardbibliotheken über IntelliSense?

Ich habe vor ein paar Tagen begonnen, C ++ mit Visual Studio 2012 zu lernen. Ich bin es gewohnt, Java mit IntelliJ IDEA zu programmieren, und dort werden Ihnen immer die Dokumentation und die erwarteten Argumente angezeigt, wenn Sie eine Methode...

12.04.2013, 14:43