Автоматическое создание документации по функциям в 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)
8 ответов
сделайте это "три одиночных комментария-маркера"
В C# это ///
который по умолчанию выплевывает:
/// <summary>
///
/// </summary>
/// <returns></returns>
щелкните правой кнопкой мыши на функцию, выберите "документ" и
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.
помните: вы должны добавить информацию за подписью метода в документацию. Не останавливайся на достигнутом. автогенерируемые документации. Значение такого инструмента заключается в том, что он автоматически генерирует документацию, которая может быть извлечена из подписи метода, поэтому любая добавленная вами информация должна быть новая информация.
это, как говорится, я лично предпочитаю, когда методы полностью selfdocumenting, но иногда у вас будут стандарты кодирования, которые требуют вне документации, а затем такой инструмент, как это, сэкономит вам много braindead typing.
///
- это ярлык для получения блока комментариев описания метода. Но перед добавлением убедитесь, что вы написали имя и подпись функции. Сначала напишите имя и подпись функции.
затем над именем функции просто введите ///
и вы получите его автоматически
Visual Assist имеет хорошее решение тоже и высоко настраиваемые.
после настройки его для создания комментариев в стиле doxygen, эти два клика будут производить -
/**
* Method: FindTheFoo
* FullName: FindTheFoo
* Access: private
* Qualifier:
* @param int numberOfFoos
* @return bool
*/
private bool FindTheFoo(int numberOfFoos)
{
}
(по умолчанию его немного по-другому.)
изменить: Способ настройки текста "метод документа" находится в разделе VassistX - >параметры Visual Assist->предложения, выберите "Редактировать фрагменты VA", язык: C++, тип: рефакторинг, затем перейдите к " документ Метод и настроить. Приведенный выше пример генерируется:
обычно Visual Studio создает его автоматически, если вы добавляете три одиночных маркера комментариев над тем, что вы хотите прокомментировать (метод, класс).
В C# это будет ///.
Если Visual Studio этого не делает, вы можете включить его в
Параметры - >Текстовый Редактор - >C# - >Дополнительно
и
создание комментариев XML-документации для ///
в visual basic, если вы сначала создадите свою функцию/sub, то в строке над ней вы наберете " три раза, он автоматически сгенерирует соответствующий xml для документации. Это также отображается при наведении мыши в intellisense и при использовании функции.
вы можете использовать фрагменты кода для вставки любых строк.
кроме того, если ввести три одинарные кавычки ("') в строке над заголовком функции, он вставит шаблон заголовка XML, который затем можно заполнить.
эти комментарии XML могут быть интерпретированы программным обеспечением документации, и они включены в выходные данные сборки как сборка.XML-файл. Если вы сохраняете этот XML-файл с DLL и ссылаетесь на эту DLL в другом проекте, эти комментарии становятся доступно в intellisense.
Я работаю над проектом с открытым исходным кодом под названием Todoc, который анализирует слова для автоматического вывода соответствующей документации при сохранении файла. Он уважает существующие комментарии и очень быстрый и гибкий.