Автоматическая генерация документации по функциям в 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)
Как сгенерировать список задач в xamarin?
Ответы 8
Вы можете использовать фрагменты кода для вставки любых строк.
Кроме того, если вы введете три одинарные кавычки ('' ') в строке над заголовком функции, будет вставлен шаблон заголовка XML, который затем можно будет заполнить.
Эти XML-комментарии могут интерпретироваться программным обеспечением для документирования, и они включаются в выходные данные сборки в виде файла assembly.xml. Если вы сохраните этот XML-файл с DLL и будете ссылаться на эту DLL в другом проекте, эти комментарии станут доступны в intellisense.
Это VB.NET: в C# это ///
Сделайте "три одиночных комментария-маркера"
В C# это ///
который по умолчанию выплевывает:
/// <summary>
///
/// </summary>
/// <returns></returns>
Вот несколько советов по редактированию шаблонов VS.
А в VB.NET это тройные одинарные кавычки (как упоминалось в другом ответе)
Это довольно аккуратно, не знал об этом
Команда «Создать комментарии XML-документации для ///» не будет работать, если предыдущая строка без пробелов начинается с «///».
Можно ли сделать это автоматически для каждого метода, свойства и переменной? Даже если код уже существует?
исправлена ссылка на подсказки очередной раз. проклят тебя, односторонняя паутина!
Как сгенерировать список задач в xamarin?
Есть ли для этого сочетание клавиш? Мне не нравится ставить курсор точно в нужное место.
Щелкните функцию правой кнопкой мыши, выберите «Задокументировать» и
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.
Помните: вы должны добавить в документацию информацию помимо сигнатуры метода. Не останавливайтесь только на автоматически созданной документации. Ценность такого инструмента в том, что он автоматически генерирует документацию, которую можно извлечь из сигнатуры метода, поэтому любая добавляемая вами информация должна быть информацией новый.
При этом я лично предпочитаю, когда методы полностью самодокументируются, но иногда у вас будут стандарты кодирования, которые требуют внешней документации, и тогда такой инструмент, как этот, избавит вас от лишнего умственного набора текста.
И это именно та «документация», которую я ненавижу. Он просто добавляет байты, ничего не сообщая мне, о которых мне еще не говорят имена методов и параметров. Не делайте этого, не отредактировав комментарий в какой-нибудь стоящий ... :-(
Конечно, вы должны редактировать его, чтобы добавить информацию. Но как шаблон он очень хорош.
@Rasmus: Это шаблон, который для хорошей документации следует полностью выбросить и все равно переписать, поскольку в нем нет информационного содержания. Так что на самом деле это больше усилий, чем если бы он был пустым.
Visual Assist также имеет хорошее решение и очень легко настраивается.
После настройки для создания комментариев в стиле doxygen эти два щелчка будут производить -
/**
* Method: FindTheFoo
* FullName: FindTheFoo
* Access: private
* Qualifier:
* @param int numberOfFoos
* @return bool
*/
private bool FindTheFoo(int numberOfFoos)
{
}
(По умолчанию все немного иначе.)
Редактировать: Чтобы настроить текст «метода документа», выберите VassistX-> Параметры Visual Assist-> Предложения, выберите «Редактировать фрагменты виртуального интерфейса», Язык: C++, Тип: Рефакторинг, затем перейдите в «Метод документа» и настройте. Приведенный выше пример создан:
Расскажите, пожалуйста, как вы это настроили в VA
Уточнял ответ. Надеюсь это поможет.
Чтобы вставить фрагмент: с курсором в имени / сигнатуре метода, alt + shift + q> "метод документа"
Я работаю над проектом с открытым исходным кодом под названием Todoc, который анализирует слова для автоматического вывода документации при сохранении файла. Он уважает существующие комментарии и работает очень быстро и плавно.
В Visual Basic, если вы сначала создаете свою функцию / подпрограмму, а затем в строке над ней вы набираете три раза, она автоматически сгенерирует соответствующий xml для документации. Это также появляется при наведении курсора мыши в intellisense и при использовании функции.
Обычно Visual Studio создает его автоматически, если вы добавляете три одиночных маркера комментария над тем, что вы хотите прокомментировать (метод, класс).
В C# это будет ///.
Если Visual Studio этого не делает, вы можете включить его в
Options->Text Editor->C#->Advanced
и проверьте
Generate XML documentation comments for ///
///
- это ярлык для получения блока комментариев "Описание метода". Но убедитесь, что вы написали имя функции и подпись, прежде чем добавлять ее. Сначала напишите имя функции и подпись.
Затем над именем функции просто введите ///
и вы получите это автоматически
милая необычная фишка поста, твоя анимация.
Как ты это сделал? Мне нравится этот ответ. Никогда раньше такого не видел.
мило. одним дополнением будут параметры функции.
Если вы попали на эту страницу из-за того, что эта функция в вашей IDE не работает, вам следует убедиться, что ваш код компилируется, и повторите попытку. Эта функция не работает, если в вашем коде есть ошибки синтаксического анализа.