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

Мне было интересно, есть ли способ (надеюсь, сочетание клавиш) для создания заголовков функций автоматического создания в 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)

Сделайте "три одиночных комментария-маркера"

В C # это ///

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

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

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

GhostDoc !

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

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+ Shift+ D.

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

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

///

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

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

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

У Visual Assist тоже есть хорошее решение , и его очень легко адаптировать.

После настройки для создания комментариев в стиле doxygen эти два щелчка будут производить -

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

}

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

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

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

В C # это было бы ///.

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

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

и проверьте

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

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

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

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

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

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

http://todoc.codeplex.com/