documentation

11Hitze

2Antwort

Wie erzwingen Sie beim Erstellen von HTML-Dokumentation, Sphinx zu melden, oder erstellen Sie einen Fehler, auf Links, die nicht existieren? Insbesondere habe ich Eigenschaften und Methoden in meinem

6Hitze

1Antwort

Wie fügen Sie der Go-Dokumentation Beispiele zur API-Dokumentation hinzu?

Es gibt einige nette executable examples in der Go-Standardbibliothek. Wie kann ich ein solches Beispiel zu meiner eigenen API-Dokumentation hinzufügen?

72Hitze

1Antwort

Dokumentieren Scala 2.10 Makros

Ich fange mit einem Beispiel an. Hier ist ein Äquivalent von List.fill für Tupeln als Makro in Scala 2.10: import scala.language.experimental.macros import scala.reflect.macros.Context object Tuple

13Hitze

1Antwort

Gibt es einen Java-API-Viewer in der Befehlszeile wie man für c und ri für Ruby?

Gibt es einen Java-API-Viewer in der Befehlszeile? Ich habe man für C-Programmierung und ri für Ruby-Programmierung verwendet. Beide scheinen mir sehr praktisch zu sein, und jetzt suche ich nach etwas

11Hitze

1Antwort

Doxygen: Gruppenmodule und Seiten?

Ich habe eine Frage zu Seiten und Gruppen in doxygen. Ich habe ein Projekt, wo ich Klassen etc. mit der @defgroup und @ingroup cmds gruppiert. Bis jetzt funktioniert das gut. Jetzt möchte ich dem Proj

9Hitze

1Antwort

Quellenunterverzeichnisse innerhalb von R-Paketen mit roxygen2 verwenden

Ich möchte eine Verzeichnisstruktur innerhalb des Ordners R für den Quellcode eines Pakets verwenden. Zum Beispiel habe ich in meinem Ordner R einen algos Ordner mit Funktionen, die ich exportieren un

8Hitze

2Antwort

YARD: Wie man eine Verbindung zu einer Klassenmethode herstellt?

Wie erstellen Sie eine Verknüpfung zu einem Ruby Klassenmethode mit YARD? Hier ist die yard documentation in Bezug auf Links. Verknüpfung mit einer Instanzmethode im gleichen Namensraum: {#my_instance

10Hitze

2Antwort

Verwendung von HACK- und UNDE-Kommentartags

Viele Softwareingenieure sind mit der Verwendung von speziellen Kommentartags, die ihren Codekommentaren hinzugefügt werden können, zur Verwendung bei Suchvorgängen, automatisierter Aufgabenverfolgung

10Hitze

1Antwort

Leitungsüberlauf in R-Dokumentation verhindern?

Dies ist eher ein Ärgernis als ein Problem, aber gibt es eine Möglichkeit, den Zeilenüberlauf zu verhindern, der auftritt, wenn Dokumentation in R kompiliert wird und eine Zeile zu lang ist? Ein Aussc

7Hitze

1Antwort

Auflösen von Namenskonflikten in Referenzen in Sphinx mit intersphinx

Ich schreibe Dokumente für meine Python-Bibliothek Mit Sphinx habe ich auch eine weitere Sphinx-Dokumentation mit intersphinx hinzugefügt. Und es funktioniert ziemlich gut, aber ein paar meiner Funkti