Kommentieren Stil (dh Javadocing C# Version) - (Java Developer Learning C#)

Question

Ich beende einige meiner ersten C# -Klassen und obwohl der ursprüngliche Code, den ich geerbt habe vollständig von Kommentaren, ich immer javadoc Kommentare auf meinem Methoden, wenn ich Java schrieb und mein Code sieht derzeit ohne diese Blöcke seltsam aus.

Normalerweise formatierte ich meine Kommentare mit dem Befehl "Insert JavaDoc" in Eclipse, der einfach die Vorlage ausgab und die Parameter, den Methodennamen usw. von der Methode, auf der der Befehl ausgeführt wurde, eingab. Dann könnte ich mehr Details von dort hinzufügen.

Gibt es einen ähnlichen Befehl in Visual Studio 2008? Ich konnte keinen finden, als ich in den Menüs herumstöberte. Gibt es außerdem eine Standardkonvention für das Kommentieren von Stil (ähnlich wie in JavaDoc), die in der C# -Welt verwendet wird?

Answer 1

Wenn Sie /// eingeben, generiert der IDE-Editor automatisch einen leeren XML-Kommentar für Sie. Diese

:

/// 
public QName(String qName, XmlNode contextNode) { 

Wird dies:

/// <summary> 
/// 
/// </summary> 
/// <param name="qName"></param> 
/// <param name="contextNode"></param> 
public QName(String qName, XmlNode contextNode) { 

Wenn Ihre Methode keine Ausnahmen auslöst Sie manuell haben werden, um Tags hinzuzufügen, da .NET nicht deklarierten Ausnahmen haben. Schlussbemerkung:

/// <summary>Creates a new QName from a string with the format 
/// <c>prefix:local-name</c> or <c>local-name</c>.</summary> 
/// 
/// <param name="qName">A QName string.</param> 
/// <param name="contextNode">An XML node from which to lookup the namespace 
/// prefix, or <c>null</c>.</param> 
/// 
/// <exception cref="XmlInvalidPrefixException">Thrown if the prefix cannot be 
/// resolved from the lookup node. If <paramref name="contextNode"/> is 
/// <c>null</c>, then the only prefix that can be resolved is <c>xml</c>. 
/// </exception> 
public QName(String qName, XmlNode contextNode) { 

Answer 2

Typ drei Schrägstriche vor jeder Methode:

/// 

Dies wird einen XML-Kommentarblock erzeugen.

Answer 3

Wenn Sie vor einer Methode in Visual Studio drei Schrägstriche "///" eingeben, wird automatisch eine einfache Vorlage für die Kommentarmethoden erstellt. (Es wird Felder für Sie erstellen, um Parameter zu kommentieren und Werte zurückzugeben.) Ich denke, das ist schön, weil es schnell und einfach ist, aber Sie möchten vielleicht etwas tiefer gehen.

Answer 4

Wenn Sie in C# drei Schrägstriche oberhalb des Kommentars eingeben, wird automatisch der entsprechende Text für das Ziel eingefügt.

Es wird eine Zusammenfassung, Parameter (falls vorhanden), Rückkehr (falls vorhanden) usw. umfassen

/// 

Sie können dann so etwas wie NDoc verwenden, um die Kommentare zu nehmen und aus ihm API-Dokumentation erstellen.

Answer 5

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

Die gesamte Funktion wird xml-doc genannt, können Sie viele Beispiele googeln.

Answer 6

Es gibt ein kostenloses Add-in für Visual Studio, GhostDoc, die Ihnen helfen, die Grundstruktur für C# XML-Dokumentation zu erstellen, bietet ein wenig mehr als /// werden Sie von Visual Studio selbst bekommen.