Автоматическое создание документации по функциям в Visual Studio

StackOverflow https://stackoverflow.com/questions/429452

Вопрос

Мне было интересно, есть ли способ (надеюсь, сочетание клавиш) создать автоматическое создание заголовков функций в Visual Studio.

Пример:

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

И это автоматически превратилось бы в что-то вроде этого...


'---------------------------------- 
'Pre: 
'Post:
'Author: 
'Date: 
'Param1 (String): 
'Param2 (Integer): 
'Summary: 
Private Function Foo(ByVal param1 As String, ByVal param2 As Integer)
Это было полезно?

Решение

Сделайте это «три отдельных маркера комментариев»

В С# это ///

который по умолчанию выдает:

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

Вот несколько советов по редактированию шаблонов VS.

Другие советы

ПризракДок!

Щелкните правой кнопкой мыши функцию, выберите «Задокументировать это» и

private bool FindTheFoo(int numberOfFoos)

становится

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

(да, это все генерируется автоматически).

Он поддерживает C#, VB.NET и C/C++.По умолчанию он сопоставлен с Ctrl+Сдвиг+Д.

Помнить:вам следует добавить в документацию информацию, выходящую за пределы сигнатуры метода.Не ограничивайтесь автоматически созданной документацией.Ценность такого инструмента в том, что он автоматически генерирует документацию, которую можно извлечь из сигнатуры метода, поэтому любая добавляемая вами информация должна быть новый информация.

При этом я лично предпочитаю, чтобы методы были полностью самодокументируемыми, но иногда у вас есть стандарты кодирования, требующие внешней документации, и тогда такой инструмент избавит вас от большого количества бессмысленного набора текста.

///

— это ярлык для получения блока комментариев описания метода.Но убедитесь, что вы написали имя и подпись функции, прежде чем добавлять ее.Сначала напишите имя и подпись функции.

Затем над именем функции просто введите ///

и вы получите это автоматически

enter image description here

Визуальный помощник имеет хорошее решение тоже, и его можно легко настроить.

После настройки на генерацию комментариев в стиле doxygen эти два клика дадут:

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

}

(При настройках по умолчанию все немного по-другому.)

Редактировать:Способ настройки текста «метода документа» находится в разделе VassistX->Параметры визуального помощника->Предложения, выберите «Редактировать фрагменты VA», «Язык»:С++, Тип:Рефакторинг, затем перейдите в «Метод документа» и настройте его.Приведенный выше пример генерируется:

va_doxy

Обычно Visual Studio создает его автоматически, если вы добавляете три одиночных маркера комментария над объектом, который вы хотите прокомментировать (метод, класс).

В С# это будет ///.

Если Visual Studio этого не делает, вы можете включить это в

Параметры->Текстовый редактор->C#->Дополнительно

и проверь

Создание комментариев XML-документации для ///

pictured description

В Visual Basic, если вы сначала создаете свою функцию/подпрограмму, а затем в строке над ней три раза вводите ', она автоматически сгенерирует соответствующий XML для документации.Это также отображается при наведении курсора мыши в Intellisense и при использовании этой функции.

Вы можете использовать фрагменты кода для вставки любых строк.

Кроме того, если вы введете три одинарные кавычки (''') в строке над заголовком функции, будет вставлен шаблон заголовка XML, который вы затем сможете заполнить.

Эти XML-комментарии могут интерпретироваться программным обеспечением для документирования и включаются в выходные данные сборки в виде файла Assembly.xml.Если вы сохраните этот XML-файл вместе с DLL и ссылаетесь на эту DLL в другом проекте, эти комментарии станут доступны в intellisense.

Я работаю над проектом с открытым исходным кодом под названием Todoc, который анализирует слова для автоматического вывода правильной документации при сохранении файла.Он уважает существующие комментарии и работает очень быстро и плавно.

http://todoc.codeplex.com/

Лицензировано под: CC-BY-SA с атрибуция
Не связан с StackOverflow
scroll top