Gibt es einen Standard (wie phpdoc oder python's docstring) für die Kommentierung von C#-Code?

Question

Gibt es eine Standardkonvention (wie phpdoc oder Python's docstring) für die Kommentierung von C#-Code, so dass die Klassendokumentation automatisch aus dem Quellcode generiert werden kann?

Answer 1

Sie können Kommentare im XML-Stil verwenden und diese Kommentare mit Hilfe von Tools in die API-Dokumentation übertragen.

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 Punkte, die dies erleichtern, sind:

GhostDoc , die eine einzige Tastenkombination für die automatische Erstellung von Kommentaren für eine Klasse oder Methode bieten. Sandburg das aus XML-Kommentaren eine Dokumentation im MSDN-Stil erzeugt.

Answer 2

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

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

Answer 3

C# hat eingebaute Dokumentationsbefehle Viel Spaß!

Answer 4

Microsoft verwendet " Kommentare zur XML-Dokumentation "Damit erhalten Sie IDE-Intelligence-Beschreibungen und können außerdem mit einem Tool wie Sandcastle automatisch eine Dokumentation im MSDN-Stil erstellen, 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 auf die Registerkarte "Erstellen". Unten können Sie einen Speicherort für Ihre XML-Kommentar-Ausgabedatei angeben.

Answer 5

In den vorangegangenen Antworten wird die XML-Syntax genau beschrieben. Ich wollte nur noch meine Empfehlung für die kostenloser (und quelloffener) Generator der nDoc-Hilfebibliothek die alle Kommentare in einem Projekt analysiert.