Automatycznie generuj dokumentację funkcji w programie Visual Studio

Zastanawiałem się, czy istnieje sposób (mam nadzieję, że skrót klawiaturowy) na utworzenie nagłówków funkcji automatycznego generowania w programie Visual Studio.

Przykład:

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

I automagicznie stałoby się czymś takim ...

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

Ustaw „trzy pojedyncze znaczniki komentarzy”

W C # to ///

który domyślnie wypluwa:

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

Oto kilka wskazówek dotyczących edycji szablonów VS.

GhostDoc !

Kliknij funkcję prawym przyciskiem myszy, wybierz „Dokumentuj to” i

private bool FindTheFoo(int numberOfFoos)

staje się

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

(tak, to wszystko jest generowane automatycznie).

Obsługuje C #, VB.NET i C / C ++. Domyślnie jest mapowany na Ctrl+ Shift+ D.

Pamiętaj: do dokumentacji należy dodać informacje poza sygnaturą metody. Nie poprzestawaj na automatycznie generowanej dokumentacji. Wartość takiego narzędzia polega na tym, że automatycznie generuje dokumentację, którą można wyodrębnić z sygnatury metody, więc wszelkie dodane informacje powinny być nowymi informacjami.

Biorąc to pod uwagę, osobiście wolę, gdy metody są całkowicie samodokumentujące, ale czasami będziesz mieć standardy kodowania, które wymagają zewnętrznej dokumentacji, a wtedy takie narzędzie pozwoli ci zaoszczędzić wiele pisania Braindead.

///

jest skrótem do uzyskania bloku komentarza Method Description. Ale upewnij się, że wpisałeś nazwę funkcji i podpis przed jej dodaniem. Najpierw wpisz nazwę i podpis funkcji.

Następnie nad nazwą funkcji wpisz ///

i otrzymasz to automatycznie

Visual Assist ma również fajne rozwiązanie i jest wysoce kosztowny.

Po poprawieniu go w celu generowania komentarzy w stylu doxygen, te dwa kliknięcia dałyby -

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

}

(Przy ustawieniach domyślnych jest nieco inny).

Edycja: Sposób dostosowania tekstu „metody dokumentu” znajduje się w VassistX-> Opcje pomocy wizualnej-> Sugestie, wybierz „Edytuj fragmenty VA”, Język: C ++, Typ: Refaktoryzacja, a następnie przejdź do „Metody dokumentu” i dostosuj. Powyższy przykład jest generowany przez:

Zwykle program Visual Studio tworzy go automatycznie, jeśli dodasz trzy pojedyncze znaczniki komentarza nad rzeczą, którą chcesz skomentować (metoda, klasa).

W C # byłoby to ///.

Jeśli program Visual Studio tego nie zrobi, możesz go włączyć w

Opcje -> Edytor tekstu -> C # -> Zaawansowane

i zaznacz

Generuj komentarze do dokumentacji XML dla ///

W Visual Basic, jeśli najpierw utworzysz funkcję / sub, a następnie w linii nad nią wpiszesz trzy razy „, automatycznie wygeneruje odpowiedni plik XML dla dokumentacji. Pojawia się również po najechaniu kursorem myszy w Intellisense i podczas korzystania z tej funkcji.

Możesz użyć fragmentów kodu, aby wstawić dowolne wiersze.

Ponadto, jeśli wpiszesz trzy pojedyncze cudzysłowy („”) w wierszu powyżej nagłówka funkcji, wstawi on szablon nagłówka XML, który możesz następnie wypełnić.

Te komentarze XML mogą być interpretowane przez oprogramowanie dokumentujące i są uwzględniane w danych wyjściowych kompilacji jako plik assembly.xml. Jeśli zachowasz ten plik XML z biblioteką DLL i będziesz odnosić się do tej biblioteki DLL w innym projekcie, komentarze te staną się dostępne w intelisense.

Pracuję nad projektem open source o nazwie Todoc, który analizuje słowa, aby automatycznie generować odpowiednią dokumentację podczas zapisywania pliku. Szanuje istniejące komentarze i działa szybko i płynnie.

http://todoc.codeplex.com/