Ответ 1
Сделайте это "три одиночных комментария-маркера"
В С# it ///
который по умолчанию выбрасывает:
/// <summary>
///
/// </summary>
/// <returns></returns>
Автоматическая генерация функциональной документации в 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)
Ответы
Ответ 2
Щелкните правой кнопкой мыши на функции, выберите "Document this" и
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)
(да, это все автогенерировано).
Он поддерживает С#, VB.NET и C/С++. Он по умолчанию отображается на Ctrl + Shift + D.
Помните: вы должны добавить информацию, помимо сигнатуры метода, в документацию. Не просто останавливайтесь на автогенерированной документации. Значение такого инструмента, как это, заключается в том, что он автоматически генерирует документацию, которая может быть извлечена из сигнатуры метода, поэтому любая информация, которую вы добавляете, должна быть новой информацией.
Я считаю, что лично я предпочитаю, когда методы полностью самодокументированы, но иногда у вас будут стандарты кодирования, которые задают внешнюю документацию, а затем подобный инструмент сэкономит вам много печатей на машинах.
Ответ 3
///
- это ярлык для получения блока комментариев описания метода. Но перед добавлением убедитесь, что вы написали имя функции и подпись. Сначала напишите имя функции и подпись.
Затем над именем функции просто введите ///
и вы получите его автоматически
Ответ 4
Visual Assist имеет отличное решение и очень высок.
После настройки его для создания комментариев в стиле doxygen эти два клика будут производить -
/**
* Method: FindTheFoo
* FullName: FindTheFoo
* Access: private
* Qualifier:
* @param int numberOfFoos
* @return bool
*/
private bool FindTheFoo(int numberOfFoos)
{
}
(В настройках по умолчанию это немного отличается.)
Изменить: Способ настройки текста "метод документа" находится в разделе "VassistX- > Параметры визуального сопровождения → " Предложения ", выберите" Редактировать фрагменты VA ", Язык: С++, Тип: Рефакторинг, затем перейдите к" Метод документа "и настройте. Вышеприведенный пример генерируется:
Ответ 5
Обычно Visual Studio создает его автоматически, если вы добавляете три отдельных маркера комментария над тем, что вам нравится комментировать (метод, класс).
В С# это будет ///.
Если Visual Studio не делает этого, вы можете включить его в
Параметры- > Текстовый редактор- > С# → Дополнительно
и проверьте
Создание комментариев документации XML для ///
Ответ 6
В Visual Basic, если вы сначала создаете свою функцию /sub, то в строке над ней вы вводите "три раза", она автоматически генерирует соответствующий XML-документ для документации. Это также отображается при наведении указателя мыши в intellisense и когда вы используете функцию.
Ответ 7
Вы можете использовать фрагменты кода для вставки любых строк, которые вы хотите.
Кроме того, если вы наберете три одиночные кавычки ('' ') в строке над заголовком функции, она будет вставлять шаблон заголовка XML, который вы затем можете заполнить.
Эти комментарии XML могут быть интерпретированы программным обеспечением для документации, и они включаются в вывод сборки как файл assembly.xml. Если вы храните этот XML файл с DLL и ссылаетесь на эту DLL в другом проекте, эти комментарии становятся доступными в intellisense.
Ответ 8
Я работаю над проектом с открытым исходным кодом под названием Todoc, который анализирует слова для автоматического вывода документации при сохранении файла. Он уважает существующие комментарии и очень быстро и легко.