Automatyczne generowanie dokumentacji funkcji w Visual Studio
Zastanawiałem się, czy istnieje sposób (mam nadzieję, że skrót klawiaturowy) na tworzenie nagłówków funkcji automatycznego generowania w visual studio.
Przykład:
Private Function Foo(ByVal param1 As String, ByVal param2 As Integer)
I automatycznie 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)
8 answers
Make that "three single comment-markers"
W C # jest ///
Które jako domyślne wypluwa:
/// <summary>
///
/// </summary>
/// <returns></returns>
Warning: date(): Invalid date.timezone value 'Europe/Kyiv', we selected the timezone 'UTC' for now. in /var/www/agent_stack/data/www/doraprojects.net/template/agent.layouts/content.php on line 54
2017-09-21 12:54:32
GhostDoc !
Kliknij prawym przyciskiem myszy na funkcji, wybierz "Document this" 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, wszystko jest autogenerowane).
Posiada wsparcie dla C#, VB.NET i C / C++. Domyślnie jest mapowane do Ctrl+Shift+D .
Pamiętaj: powinieneś dodać do dokumentacji informacje wykraczające poza podpis metody. Nie poprzestaj NA automatycznie wygenerowanej dokumentacji. Wartość takiego narzędzia polega na tym, że automatycznie generuje dokumentację, którą można wyodrębnić z podpisu metody, więc każda dodana informacja powinna być nową informacją.
Biorąc to pod uwagę, osobiście wolę, gdy metody są całkowicie autotematyczne, ale czasami będziesz miał standardy kodowania, które upoważniają poza dokumentacją, a wtedy takie narzędzie zaoszczędzi Ci dużo mądrego pisania.
Warning: date(): Invalid date.timezone value 'Europe/Kyiv', we selected the timezone 'UTC' for now. in /var/www/agent_stack/data/www/doraprojects.net/template/agent.layouts/content.php on line 54
2018-03-02 10:35:54
///
Jest skrótem do pobrania bloku komentarza opis metody. Ale upewnij się, że napisałeś nazwę funkcji i podpis przed dodaniem jej. Najpierw wpisz nazwę funkcji i podpis.
Następnie powyżej nazwy funkcji wpisz / / /
I otrzymasz go automatycznie
Warning: date(): Invalid date.timezone value 'Europe/Kyiv', we selected the timezone 'UTC' for now. in /var/www/agent_stack/data/www/doraprojects.net/template/agent.layouts/content.php on line 54
2016-05-10 11:16:46
Visual Assist ma równieżładne rozwiązanie i jest wysoce kosztowny.
Po poprawieniu go w celu wygenerowania komentarzy w stylu doxygen, te dwa kliknięcia spowodowałyby -
/**
* Method: FindTheFoo
* FullName: FindTheFoo
* Access: private
* Qualifier:
* @param int numberOfFoos
* @return bool
*/
private bool FindTheFoo(int numberOfFoos)
{
}
(w ustawieniach domyślnych, jest nieco inny.)
Edytuj: Sposób dostosowania tekstu "metody dokumentu" znajduje się pod vassistx->opcje pomocy wizualnej->sugestie, wybierz "Edytuj fragmenty VA", Język: C++, wpisz: Refaktoryzacja, a następnie przejdź do "metody dokumentu" i dostosuj. Powyżej przykład jest generowany przez:
Warning: date(): Invalid date.timezone value 'Europe/Kyiv', we selected the timezone 'UTC' for now. in /var/www/agent_stack/data/www/doraprojects.net/template/agent.layouts/content.php on line 54
2016-11-01 15:21:54
Zazwyczaj 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 Visual Studio tego nie zrobi, możesz włączyć go w
Opcje - > Edytor Tekstu->C# - > Zaawansowane
I sprawdź
Generowanie komentarzy do dokumentacji XML dla / / /
Warning: date(): Invalid date.timezone value 'Europe/Kyiv', we selected the timezone 'UTC' for now. in /var/www/agent_stack/data/www/doraprojects.net/template/agent.layouts/content.php on line 54
2016-12-02 20:01:22
W visual basic, jeśli najpierw utworzysz swoją funkcję / sub, a następnie w linii powyżej wpisz ' trzy razy, to automatycznie wygeneruje odpowiedni xml dla dokumentacji. Pojawia się również podczas mycia myszką w intellisense i podczas korzystania z funkcji.
Warning: date(): Invalid date.timezone value 'Europe/Kyiv', we selected the timezone 'UTC' for now. in /var/www/agent_stack/data/www/doraprojects.net/template/agent.layouts/content.php on line 54
2012-07-17 19:50:42
Możesz użyć urywków kodu, aby wstawić dowolne linie.
Ponadto, jeśli wpiszesz trzy pojedyncze cudzysłowy ("') w linii nad nagłówkiem funkcji, wstawi on szablon nagłówka XML, który możesz następnie wypełnić.
Te komentarze XML mogą być interpretowane przez oprogramowanie dokumentacji i są zawarte w wyjściu kompilacji jako assembly.plik xml. Jeśli zachowasz ten plik XML z DLL i odwołasz się do niego w innym projekcie, komentarze te staną się dostępne w intellisense.
Warning: date(): Invalid date.timezone value 'Europe/Kyiv', we selected the timezone 'UTC' for now. in /var/www/agent_stack/data/www/doraprojects.net/template/agent.layouts/content.php on line 54
2009-01-09 19:59:50
Pracuję nad projektem open-source o nazwie Todoc, który analizuje słowa, aby stworzyć odpowiednie wyjście dokumentacji automatycznie podczas zapisywania pliku. Szanuje istniejące komentarze i jest naprawdę szybki i płynny.
Warning: date(): Invalid date.timezone value 'Europe/Kyiv', we selected the timezone 'UTC' for now. in /var/www/agent_stack/data/www/doraprojects.net/template/agent.layouts/content.php on line 54
2012-04-21 01:27:20