Wie exportiere ich die Codedokumentation in C# / VisualStudio 2008?

Question

Ich habe immer Wert darauf gelegt, schöne Codekommentare für Klassen und Methoden mit der C#-XML-Syntax zu schreiben.Ich habe immer erwartet, dass ich sie später problemlos exportieren kann.

Heute muss ich es tatsächlich tun, habe aber Schwierigkeiten herauszufinden, wie.Fehlt mir etwas?Ich will gehen Menü->Build->Build-Code-Dokumentation, aber es gibt dort keine Möglichkeit, das zu tun.

Answer 1

Eigentlich steht es in den Projekteigenschaften.Klicken Sie auf die Registerkarte „Build“, den Abschnitt „Ausgabe“, die XML-Dokumentationsdatei und geben Sie den Dateinamen ein.Es wird auf jedem Build des Projekts aufgebaut.

Danach können Sie die eigentliche Hilfe erstellen Sandburg.

Answer 2

Du könntest es versuchen NDOC oder Sandburg wenn es Ihnen nichts ausmacht, Tools von Drittanbietern zu verwenden.

Answer 3

Sandburg funktioniert ziemlich gut zum Generieren von Dokumentation und unterstützt eine Reihe verschiedener Formate für die Generierung.Soweit ich weiß, gibt es dafür keine Visual Studio-Integration, aber eine SandcastleGUI dafür, was vorhanden ist.

Answer 4

Seien Sie vorsichtig, wenn Sie LINQ to SQL verwenden, da Sie den automatisch generierten Objekten nicht einfach nachhaltige Kommentare hinzufügen können.

Answer 5

Später Kommentar, aber es lohnt sich hinzuzufügen, dass Sandcastle zwar eingemottet ist, das Sandcastle-Hilfedatei-Builder befindet sich weiterhin in der aktiven Entwicklung, und ich fand es sehr leistungsstark und einfach, sich darauf einzulassen, wenn man gerade diese Situation bewältigt – die Installation in Rich-CHM- und .html/.asp-Ausgaben in ein paar Stunden.

Answer 6

Das ursprüngliche NDoc-Projekt (von anderen erwähnt) ist tot, aber es gibt ein neues Projekt namens NDoc3.

NDoc3 unterstützt .NET 2.0 - 3.5.Es ist derzeit als Beta-Version verfügbar und hat bei mir großartig funktioniert.Ich bin mir nicht sicher, ob das Projekt noch aktiv ist – die letzte Beta wurde im April 2009 veröffentlicht.