documentation-generation

5Hitze

2Antwort

Verwendung von WCF in .NET Wie kann ich das automatische Generieren von SOAP-Dokumenten wie ASMX machen?

Ich schreibe gerade einen Web-Service mit WCF in VB.NET. Vorherige Webdienste Ich schrieb gebrauchte ASMX, aber ich wollte WCF lernen und bis jetzt läuft es gut. Ich bevorzuge die Art, wie WCF Dinge m

13Hitze

2Antwort

Wie werden Docstrings in Java aufgerufen?

Bevor Java-Methoden haben wir so etwas wie: /** * Takes a number and returns its square root. * @param x The value to square. * @return The square root of the given number. */ public float getSqr

5Hitze

1Antwort

Wie kann ich eine Datei erstellen, die nur "öffentliche" APIs in Doxygen dokumentiert

Ich habe ein Projekt, an dem ich arbeite, das ist eine Bibliothek. Ich muss die Interna des Bibliothekscodes für meine eigenen Zwecke dokumentieren, muss aber auch ein API-Dokument an meine Benutzer w

5Hitze

2Antwort

Automatisches @since javadoc-Tag für Releases

Gibt es ein Tool zum automatischen Hinzufügen des Tags @since zu allen Elementen, wenn ich eine Release-Version haben möchte? Also lassen Sie sich sagen, ich habe eine Reihe von Methoden und mein Bank

24Hitze

2Antwort

Wie schreiben Sie Ihre Paketdokumentation?

Ich habe noch keinen vernünftigen Workflow zum Erstellen von Paketen und Schreiben ihrer Dokumentation gefunden. Ich möchte so viel von dem Prozess (und der Dokumentation) wie möglich automatisch gene

10Hitze

3Antwort

Mit Gurke oder RSpec + Selenium Endbenutzerdokumentation erstellen?

Hat jemand versucht, aus Ihren Gurkenszenarien Endbenutzer (möglicherweise online, möglicherweise gedruckte) Hilfe/Dokumentation zu erstellen? Oder Screenshots für den Einsatz in der Dokumentation mit

6Hitze

4Antwort

Ersetzen Python Docstrings

Ich habe einen epytext zu reST Markup-Konverter geschrieben, und jetzt möchte ich alle Docstrings in meiner gesamten Bibliothek von Epytext in ReST-Format konvertieren. Gibt es eine intelligente Mögli

28Hitze

5Antwort

C++: Wo schreibe ich die Code-Dokumentation: in .cpp oder in .hpp-Dateien?

Wo ist es üblich, die In-Code-Dokumentation von Klassen und Methoden zu schreiben? Schreiben Sie solche Doc-Blöcke über die entsprechende Klasse/Methode in der Headerdatei (.hpp) oder in der Quelldate

18Hitze

4Antwort

VS2010: Automatisch generierte Dateien und XML-Dokumentation

Dies ist wirklich nur um this question asked about Visual Studio 2008. Bietet VS2010 eine Funktion, um die CS1591-Compiler-Warnung für automatisch generierten Code zu entfernen? CS1591: Missing XML co

21Hitze

3Antwort

Grails: Alternativen zu Grails Doc?

Die Dokumentation von grails doc erstellt erstellt ist in meinen Augen nicht vollständig zufriedenstellend. Zum Beispiel erscheinen Aktionen in Controllern als Eigenschaften in der Dokumentation, obwo