documentation

7Hitze

2Antwort

Gibt es eine gute Möglichkeit, Dokumentation für Swig-Schnittstellen zu erstellen?

Ich würde gerne wissen, ob es gute Techniken für die Erstellung/Pflege Dokumentation auf der Schnittstelle gibt. Ich baue eine Schnittstelle von C++ - Code zu Python mit swig; meistens bin ich nur % e

python documentation swig 2012-07-11

---

6Hitze

3Antwort

Doc-Zeichenfolge-Einrichtung in C++

Sprachen wie Python, MATLAB, E-Lisp haben diese nette Einrichtung für Doc-Strings. Mit dieser Funktion können Sie mit nur wenigen Tastenanschlägen im Terminal die Dokumentationen der Funktionen/Module

c++ c documentation 2012-05-28

---

10Hitze

1Antwort

Auslassen (oder formatieren) des Wertes einer Variablen beim Dokumentieren mit Sphinx

Ich dokumentiere gerade ein ganzes Modul mit autodoc. Ich definiere jedoch mehrere Variablen auf der Modulebene, die lange Listen oder Dicts enthalten. Sie sind in der Dokumentation zusammen mit den W

python documentation python-sphinx 2012-06-02

---

22Hitze

2Antwort

Clojure-Dokumentation für Bibliotheken/Namespaces

Wie fügen Sie Docstrings und/oder Kommentare zu Clojure-Bibliotheken/Namespaces als Ganzes hinzu, d. H. Nicht nur zu bestimmten Funktionen im Namespace? Ich habe festgestellt, dass die Clojure-Quelle

clojure documentation docstring 2012-07-23

---

22Hitze

3Antwort

Sphinx und argparse - Autodocumentation Befehlszeilenskripte?

Ich baue ein Python-Paket und benutze Sphinx, um die Dokumente zu erstellen. Abgesehen von meinem Paketcode schließe ich auch viele Python-Skripte ein, die argparse verwenden. Ich habe mich gefragt, o

python documentation python-sphinx argparse 2012-06-04

---

11Hitze

1Antwort

zwei oder mehr Datentypen in PHPDoc @param

ok Ich habe tun, um diese phpdoc über meine Klassenmethode /** * this a function that translates the text * @param string|boolean $lang if string the string given in the parameter will be the langua

php documentation phpdoc 2012-07-26

---

5Hitze

3Antwort

Sandcastle nicht dokumentiert Eigenschaftszusammenfassungen

Ich benutze heute SandCastle mit der HelpBuilder GUI zum ersten Mal, um eine API von einigen unserer exponierten Funktionen und Eigenschaften zu erstellen. Ich habe /// <summary> ... </summary auf ein

c# documentation sandcastle 2012-06-07

---

11Hitze

3Antwort

Welche Arten von Dokumenten werden für die Softwareentwicklung benötigt?

Ich kenne das Dokument zur funktionalen Anforderung und das Dokument zur technischen Spezifikation. Allerdings würde ich gerne wissen, welche verschiedenen Dokumente für eine Gesamtprojektentwicklung

documentation project-management 2012-07-30

---

14Hitze

2Antwort

Wo kann die Versionsnummer der Rails-App definiert werden

Gibt es eine Konvention darüber, wie/wo die Versionsnummer der Anwendung angegeben werden soll? Zum Beispiel wird für die Ruby Gems lib/mygem/version.rb die Datei in der Regel für diesen Zweck verwend

ruby-on-rails ruby documentation versioning 2012-06-26

---

19Hitze

4Antwort

Gibt es eine Möglichkeit, ein Dokumentations-Wiki für Github aus meinen XML-Dokumentationskommentaren in C# zu generieren?

Ich möchte API-Dokumentation für mein Open Source-Projekt auf Github generieren. Ich möchte sie automatisch aus meinen XML-Dokumentationskommentaren in meinen C# -Projekten erstellen. Mein schwaches g

visual-studio-2010 github documentation markdown wiki 2012-06-28

---