So fügen Sie einer Funktion eine Dokumentation hinzu, wenn Sie ein NuGet-Paket erstellen

Question

Ich baue ein internes NuGet-Paket für die Arbeit und möchte es so einfach wie möglich machen.

Wie schließe ich Funktionsdefinitionen und Beschreibungen für offene Methoden im NuGet-Paket ein?

ich für ähnlich wie diese etwas los:

Gibt es etwas, was ich mein Paket hinzufügen müssen diese Einzelheiten zur Verfügung zu stellen, was die Funktion tut?

Zusätzliche Punkte, um zu erklären, wie man es mit dem Nuget Package Explorer Tool macht.

Answer 1

Diese Art von Dokumentation wird über XML documentation comments hinzugefügt. Wenn Sie bei aktivierter Option XML-Dokumentation generieren eine XML-Datei erstellen, wird neben Ihrer DLL eine XML-Datei erstellt, die die Dokumentation enthält. Sie können das in Ihre .nuspec-Datei aufnehmen, um es mit Ihrer Bibliothek zu verteilen, und Visual Studio wird es automatisch übernehmen.

auf Ihre Funktionen umfassen nur die Tags, die Sie im /// Block wollen:

/// <summary> 
/// Returns "Hello World!" 
/// </summary> 
/// <remarks>This function is pretty useless, actually.</remarks> 
public string HelloWorld() 

eine Reihe von gemeinsamen Es gibt und recommended tags Sie verwenden können. Visual Studio sollte Ihnen in der Lage sein, Ihnen Intellisense zur Verfügung zu stellen.

Wenn Sie das Paket Gebäude sind, aktivieren Sie die XML-Dokumentation Option generieren und schließen die generierte XML-Datei in der nuspec Datei, wie sie in dieser Frage beschrieben: How do you include Xml Docs for a class library in a NuGet package?