5 Stimmen

Wie man den Prozess der Code-Dokumentation vereinfacht - Visual Studio C#

Ich frage mich, ob es irgendeine Abkürzung in Visual Studio gibt, um automatische Dokumentation für eine Methode oder Klasse zu generieren.

Wenn ich zum Beispiel eine Methode schreibe:

public void MyFunction(int d)
{

}

Ich möchte die folgende Struktur erzeugen:

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

11voto

Oded Punkte 475566

Dies geschieht, wenn Sie Folgendes eingeben /// oberhalb der Methodensignatur.

Sie können auch ein Dokumentationsprogramm installieren und verwenden, z. B. GhostDoc die auch die erzeugte Code-Dokumentation um einige Details ergänzt.

4voto

Ich benutze GhostDoc für diese. Das heißt, Sie können mit der rechten Maustaste auf eine Methode klicken und die Kommentare werden eingefügt. Der Hauptvorteil ist, dass auch ein Standardkommentartext eingefügt wird, was sehr nützlich ist.

1voto

Jason Williams Punkte 55292

Schauen Sie sich mein Addin an, Atomineer Pro Dokumentation . Es ist ähnlich wie GhostDoc, aber wesentlich leistungsfähiger und flexibler.

CodeJaeger.com

CodeJaeger ist eine Gemeinschaft für Programmierer, die täglich Hilfe erhalten..
Wir haben viele Inhalte, und Sie können auch Ihre eigenen Fragen stellen oder die Fragen anderer Leute lösen.

Powered by:

X