Wie kann ich die Codedokumentation in C#/VisualStudio 2008 exportieren?

Question

Ich habe immer einen Punkt gemacht, nette Code-Kommentare 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 eigentlich tun, aber ich habe Schwierigkeiten herauszufinden, wie. Gibt es etwas, das mir fehlt? Ich möchte gehen Menü-> Build-> Build Code Dokumentation, aber es gibt keine Option, das zu tun, dort.

Answer 1

Eigentlich ist es in den Projekteigenschaften. Registerkarte Erstellen, Abschnitt Ausgabe, XML-Dokumentationsdatei und geben Sie den Dateinamen ein. Es wird bei jedem Build des Projekts erstellt.

Danach können Sie die eigentliche Hilfe mit Sandcastle bauen.

Answer 2

Sie könnten versuchen, NDOC oder SandCastle, wenn Sie nichts dagegen haben, mit 3rd-Party-Tools.

Answer 3

Sandcastle funktioniert sehr gut zum Generieren von Dokumentation und es unterstützt ein paar verschiedene Formate für die Generierung. Soweit ich weiß, gibt es keine Visual Studio-Integration dafür, aber es gibt eine SandcastleGUI dafür, die verfügbar ist.

Answer 4

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

Answer 5

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 funktionierte großartig für mich. Ich bin mir nicht sicher, ob das Projekt noch aktiv ist - die letzte Beta wurde im April 2009 freigegeben.

Answer 6

Späte Kommentar, aber wert hinzuzufügen, dass, obwohl Sandcastle eingemottet ist, bleibt die Sandcastle Help File Builder in der aktiven Entwicklung, und ich fand es sehr Leistungsstark und unkompliziert, wenn Sie sich mit dieser Situation beschäftigen - installieren Sie in wenigen Stunden die Rich .chm- und .html/.asp-Ausgabe.