Auto-Funktion Dokumentation in Visual Studio generiert

Question

ich mich gefragt, ob es einen Weg gibt (hoffentlich Tastenkombination) Auto zu schaffen Funktion Header in Visual Studio generieren.

Beispiel:

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

Und es würde automatisch so etwas wie dieses wird ...

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

Answer 1

Sie sich, dass "drei Einzel Kommentar-Marker"

In C # ist es ///

, die als Standard ausspuckt:

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

Hier ist einige Tipps zur Bearbeitung von VS-Vorlagen .

Answer 2

GhostDoc !

Rechtsklick auf die Funktion, wählen Sie „Dokument dieses“ 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, es ist alles automatisch generiert).

Es hat Unterstützung für C #, VB.NET und C / C ++. Es ist standardmäßig zugeordnet Strg + Umschalttaste + D .

Denken Sie daran: Sie Informationen über die Methodensignatur in der Dokumentation hinzufügen sollten. Nicht nur mit der automatisch generierte Dokumentation zu stoppen. Der Wert eines Werkzeug wie dieser ist, dass es automatisch die Dokumentation erzeugt, die aus der Methodensignatur extrahiert werden können, so dass alle Informationen, die Sie hinzufügen sollen seine neue Informationen.

aber sagen, dass ich persönlich lieber, wenn Methoden völlig sind selfdocumenting, aber manchmal müssen Sie Codierung-Standards, die außerhalb Dokumentation beauftragen, und dann ein Werkzeug, wie diese werden Sie eine Menge hirntot Eingabe speichern.

Answer 3

///

ist die Abkürzung für die Beschreibung Kommentarblock Methode bekommen. Aber stellen Sie sicher, dass Sie den Namen der Funktion und Unterschrift geschrieben haben, bevor sie hinzugefügt wird. Zuerst schreiben Sie die Funktion Namen und Unterschrift.

Dann über die Funktionsnamen geben Sie einfach ///

und Sie werden es automatisch erhalten

Answer 4

Der Visual Assist hat eine schöne Lösung auch, und ist sehr costumizable.

Nach Tweaking es doxygen-Stil Kommentare zu erzeugen, wobei diese beiden Klicks erzeugen würde -

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

}

(unter Standardeinstellungen, die ein bisschen anders.)

---

Edit: Die Art und Weise des ‚Dokument-Methode‘ Text anzupassen, ist unter VassistX-> Visuelle Assist Optionen-> Vorschläge, wählen Sie ‚Bearbeiten VA Snippets‘, Sprache: C ++, Typ: Refactoring, dann gehen Sie auf ‚Dokument Methode‘ und anpassen. Das obige Beispiel erzeugt durch:

Answer 5

Normalerweise Visual Studio erstellt es automatisch, wenn Sie Sie über die Sache drei Einzel Kommentar-Marker hinzufügen, Kommentar (Methode, Klasse).

In C # wäre dies /// .

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

  

Optionen-> Text Editor-> C # -> Erweitert

und überprüfen

  

XML-Dokumentationskommentare für /// generieren

Answer 6

In Visual Basic, wenn Sie Ihre Funktion / sub erstellen zuerst, dann auf der Linie darüber, geben Sie dreimal ', es wird die entsprechende xml für die Dokumentation automatisch generieren. Dies zeigt auch auf, wenn Sie in intellisense Mouseover, und wenn Sie die Nutzung der Funktion machen.

Answer 7

Sie können Code-Schnipsel verwenden, um alle Zeilen einfügen Sie wollen.

Auch wenn Sie drei einfache Anführungszeichen eingeben ( ‚‘ ') auf der Linie über dem Funktionskopf, wird die XML-Header-Vorlage einfügen, die Sie dann ausfüllen können.

Diese XML-Kommentare können durch Dokumentations-Software interpretiert werden, und sie sind in der Build-Ausgabe als assembly.xml-Datei enthalten. Wenn Sie diese XML-Datei halten mit dem DLL und Referenz, die DLL in einem anderen Projekt, diese Kommentare in intellisense verfügbar sind.

Answer 8

Ich arbeite an einem Open-Source-Projekt namens Todoc die Worte ordnungsgemäße Dokumentation Ausgabe automatisch zu erzeugen, Analysen beim Speichern einer Datei. Es respektiert bestehende Kommentare und ist wirklich schnell und flüssig.

http://todoc.codeplex.com/