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

Question

Gibt es eine Standardkonvention (wie phpdoc oder python's Docstring) zum Kommentieren 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 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 zu erleichtern dies ist:

GhostDoc, die eine einzige Tastenkombination geben, um automatisch zu generieren Kommentare für eine Klasse oder Methode. Sandcastle, die MSDN-Stildokumentation aus XML-Kommentaren generiert.

Answer 2

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

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

Answer 3

C# hat in documentation commands Haben Sie Spaß gebaut!

Answer 4

Microsoft verwendet "XML Documentation Comments", das IDE-Intellisense-Beschreibungen gibt und Ihnen außerdem ermöglicht, MSDN-style-Dokumentation mit einem Tool wie Sandcastle automatisch 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 im Visual Studio, klicken Sie auf "Eigenschaften" und gehen Sie auf die Registerkarte "Erstellen". Nach unten können Sie einen Speicherort für Ihre XML-Kommentardatei angeben.

Answer 5

Die vorherigen Antworten zeigen die XML-Syntax perfekt. Ich wollte nur meine Empfehlung für die free (and open-source) nDoc help library generator, die alle Kommentare in einem Projekt analysiert.

Answer 6

Mir wurde immer gesagt, dass Blockkommentare, die mit 2 oder mehr Sternchen geöffnet wurden, Dokumentationskommentare abgrenzen.

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