Automatische Generierung der Funktionsdokumentation in Visual Studio

Ich habe mich gefragt, ob es eine Möglichkeit gibt (hoffentlich eine Tastenkombination), automatisch generierte Funktionsheader in Visual Studio zu erstellen.

Beispiel:

Private Function Foo(ByVal param1 As String, ByVal param2 As Integer)

Und es würde automatisch so etwas werden ...

'---------------------------------- 
'Pre: 
'Post:
'Author: 
'Date: 
'Param1 (String): 
'Param2 (Integer): 
'Summary: 
Private Function Foo(ByVal param1 As String, ByVal param2 As Integer)

Machen Sie das "drei einzelne Kommentar-Marker"

In C # ist es ///

was standardmäßig ausspuckt:

/// <summary>
/// 
/// </summary>
/// <returns></returns>

Hier einige Tipps zum Bearbeiten von VS-Vorlagen.

GhostDoc !

Klicken Sie mit der rechten Maustaste auf die Funktion, wählen Sie "Dokumentieren" und

private bool FindTheFoo(int numberOfFoos)

wird

/// <summary>
/// Finds the foo.
/// </summary>
/// <param name="numberOfFoos">The number of foos.</param>
/// <returns></returns>
private bool FindTheFoo(int numberOfFoos)

(Ja, alles wird automatisch generiert).

Es unterstützt C #, VB.NET und C / C ++. Es ist standardmäßig Ctrl+ Shift+ zugeordnet D.

Denken Sie daran: Sie sollten der Dokumentation Informationen hinzufügen, die über die Methodensignatur hinausgehen. Hören Sie nicht nur mit der automatisch generierten Dokumentation auf. Der Wert eines solchen Tools besteht darin, dass es automatisch die Dokumentation generiert, die aus der Methodensignatur extrahiert werden kann. Daher sollten alle Informationen, die Sie hinzufügen, neue Informationen sein.

Abgesehen davon bevorzuge ich persönlich, wenn Methoden vollständig selbstdokumentierend sind, aber manchmal haben Sie Codierungsstandards, die externe Dokumentation vorschreiben, und dann erspart Ihnen ein solches Tool viel Braindead-Typisierung.

///

ist die Verknüpfung zum Abrufen des Kommentarblocks "Methodenbeschreibung". Stellen Sie jedoch sicher, dass Sie den Funktionsnamen und die Signatur geschrieben haben, bevor Sie sie hinzufügen. Schreiben Sie zuerst den Funktionsnamen und die Signatur.

Geben Sie dann über dem Funktionsnamen einfach /// ein.

und Sie erhalten es automatisch

Visual Assist hat auch eine gute Lösung und ist sehr kostümierbar.

Nach dem Optimieren, um Kommentare im Sauerstoffstil zu generieren, würden diese beiden Klicks Folgendes erzeugen:

/**
* Method:    FindTheFoo
* FullName:  FindTheFoo
* Access:    private 
* Qualifier:
* @param    int numberOfFoos
* @return   bool
*/
private bool FindTheFoo(int numberOfFoos)
{

}

(In den Standardeinstellungen ist es etwas anders.)

Bearbeiten: Die Möglichkeit, den Text 'Dokumentmethode' anzupassen, finden Sie unter VassistX-> Visual Assist-Optionen-> Vorschläge. Wählen Sie 'VA-Snippets bearbeiten', Sprache: C ++, Typ: Refactoring, gehen Sie zu 'Dokumentmethode' und passen Sie ihn an. Das obige Beispiel wird generiert von:

Normalerweise erstellt Visual Studio es automatisch, wenn Sie drei einzelne Kommentarmarkierungen über dem Element hinzufügen, das Sie kommentieren möchten (Methode, Klasse).

In C # wäre das ///.

Wenn Visual Studio dies nicht tut, können Sie es in aktivieren

Optionen-> Texteditor-> C # -> Erweitert

und prüfe

Generieren Sie XML-Dokumentationskommentare für ///

Wenn Sie in Visual Basic zuerst Ihre Funktion / Ihr Sub erstellen und dann in der darüber liegenden Zeile dreimal 'eingeben, wird die relevante XML für die Dokumentation automatisch generiert. Dies wird auch angezeigt, wenn Sie in Intellisense mit der Maus darüber fahren und die Funktion verwenden.

Sie können Codefragmente verwenden, um beliebige Zeilen einzufügen.

Wenn Sie drei einfache Anführungszeichen ('' ') in die Zeile über dem Funktionsheader eingeben, wird die XML-Header-Vorlage eingefügt, die Sie dann ausfüllen können.

Diese XML-Kommentare können von der Dokumentationssoftware interpretiert werden und sind in der Build-Ausgabe als Assembly.xml-Datei enthalten. Wenn Sie diese XML-Datei mit der DLL behalten und auf diese DLL in einem anderen Projekt verweisen, werden diese Kommentare in Intellisense verfügbar.

Ich arbeite an einem Open-Source-Projekt namens Todoc, das Wörter analysiert, um beim Speichern einer Datei automatisch die richtige Dokumentationsausgabe zu erhalten. Es respektiert vorhandene Kommentare und ist sehr schnell und flüssig.

http://todoc.codeplex.com/