Mithilfe von doxygen zur Erstellung der Dokumentation für die bestehenden C# - code mit XML-Kommentaren

Habe ich gelesen überall, dass doxygen ist der Weg zu gehen für die Generierung von Dokumentation für C# - code. Ich habe eine einzige Schnittstelle, die ich dokumentieren wollen ersten (baby -) Schritte, und es hat bereits die XML-Kommentare (///) zu präsentieren.

Aufgrund der großen Anzahl von Beiträgen und Informationen zur Verfügung (einschließlich doxygen.org), die sagen, diese Kommentare sind schon unterstützt, ich bin überrascht, dass wenn ich doxywizard, bekomme ich Fehler wie "warning: Compound-Unternehmen::Produkt::MyInterface ist nicht dokumentiert".

Dies führt mich zu glauben, dass ich irgendwie missverstanden XML-Dokumentation (hoffentlich nicht, nach MSDN ich spreche über die richtige), oder habe ich falsch konfiguriert doxywizard.

Ich das erste lief doxywizard über den Assistenten tab, und angegeben, dass ich möchte, zu unterstützen C#/Java. Wenn ich es laufen, meine HTML-Seite ist leer, vermutlich wegen der zuvor genannten Warnungen. Ich habe dann versucht Sie eine einzelne Datei über den Reiter Expert und lief wieder an-das gleiche Verhalten.

Kann mir jemand sagen was für Schalter oder eine Einstellung fehlt mir zu bekommen doxygen generieren HTML?

Hier ist ein Beispiel, wie eine dokumentierte Eigenschaft/Methode sieht aus wie in meinem interface:

///<summary>
///Retrieve the version of the device
///</summary>
String Version { get; }

///<summary>
///Does something cool or really cool
///</summary>
///<param name="thing">0 = something cool, 1 = something really cool</param>
void DoSomething( Int32 thing);

Habe ich eine Bemerkung über die Schnittstelle, wie diese:

///<summary>
///MyInterface
///</summary>
public interface MyInterface {...}
  • Dave, Sie haben eine Anmerkung über der Zeile, in der das interface deklariert ist?
  • ja, ich weiß... habe ich aktualisiert meine Frage zu zeigen, den Kommentar. Vielleicht brauche ich einige spezielle doxygen-syntax gibt es?
  • Hmmm.... Dass alle gut aussieht. Alles was ich denken kann, ist, dass es eine Reihe von EXTRACT_ Parameter. Versuchen Sie, Sie alle zu JA. Was Sie versuchen zu tun, funktionieren wird. Es ist einfach etwas fehlt. Es ist ein wenig trial-and-error erforderlich mit doygen, die ich möchte.
  • haha, gutes timing! Ich habe gerade gebucht über, dass nach der Lektüre etwas über EXTRACT_ALL. Ermöglicht, dass es zu arbeiten, aber ich glaube es sollte gearbeitet haben, auch mit dieser Einstellung deaktiviert. Danke für die Kommentare.
InformationsquelleAutor Dave | 2011-08-31
Schreibe einen Kommentar