Gibt es einen Standard (wie phpdoc oder Pythons Docstring) zum Kommentieren von C#-Code?

Question

Gibt es eine Standardkonvention (wie phpdoc oder python's docstring) zum Kommentieren von C#-Code, damit die Klassendokumentation automatisch aus dem Quellcode generiert werden kann?

Answer 1

Sie können Kommentare im XML-Stil verwenden und Tools verwenden, um diese Kommentare in die API-Dokumentation zu übernehmen.

Hier ist ein Beispiel für den Kommentarstil:

/// <summary>
/// Authenticates a user based on a username and password.
/// </summary>
/// <param name="username">The username.</param>
/// <param name="password">The password.</param>
/// <returns>
/// True, if authentication is successful, otherwise False.
/// </returns>
/// <remarks>
/// For use with local systems
/// </remarks>
public override bool Authenticate(string username, string password)

Einige Elemente, die dies erleichtern sollen, sind:

GhostDoc, die eine einzige Tastenkombination zum automatischen Generieren von Kommentaren für eine Klasse oder Methode bereitstellen.Sandburg, das aus XML-Kommentaren eine Dokumentation im MSDN-Stil generiert.

Answer 2

/// <summary>
///
/// </summary>
/// <param name="strFilePath"></param>

http://msdn.microsoft.com/en-us/magazine/cc302121.aspx

Answer 3

Microsoft verwendet „Kommentare zur XML-Dokumentation", das IDE-Intellisense-Beschreibungen liefert und es Ihnen auch ermöglicht, mit einem Tool wie Sandcastle automatisch Dokumentation im MSDN-Stil zu generieren, wenn Sie die Generierung der XML-Dateiausgabe aktivieren.

Um die Generierung der XML-Datei für die Dokumentation zu aktivieren, klicken Sie mit der rechten Maustaste auf ein Projekt in Visual Studio, klicken Sie auf „Eigenschaften“ und gehen Sie zur Registerkarte „Erstellen“.Unten können Sie einen Speicherort für Ihre XML-Kommentarausgabedatei angeben.

Answer 4

Die vorherigen Antworten weisen perfekt auf die XML-Syntax hin.Ich wollte nur meine Empfehlung dafür abgeben kostenloser (und Open-Source) nDoc-Hilfebibliotheksgenerator das alle Kommentare in einem Projekt analysiert.

Answer 5

C# ist integriert DokumentationsbefehleViel Spaß!

Answer 6

Mir wurde immer gesagt, ich solle Blockkommentare verwenden, die mit zwei oder mehr Sternchen geöffnet sind, um Dokumentationskommentare abzugrenzen.

/**
Documentation goes here.
(flowerboxes optional) 
*/