Автоматический генерируют функциональную документацию в Visual Studio
Независимо от того, что вы делаете в конечном итоге, убедитесь, что вы проверяете, что ваш вход еще не был искажен magic_quotes или каким-то другим благонамеренным мусором, и, если необходимо, запустите его через stripslashes или что-то еще, чтобы его дезинфицировать .
4 ответа
Сделайте те "три единственными маркерами комментария"
В C#, который это ///
, который как значение по умолчанию выкладывает:
/// <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 + Сдвиг + D .
Помните: необходимо добавить информацию вне сигнатуры метода к документации. Только остановитесь с автоматически сгенерированной документацией. Значение инструмента как это - то, что он автоматически генерирует документацию, которая может быть извлечена из сигнатуры метода, таким образом, любая информация, которую Вы добавляете, должна быть новая информация.
Однако я лично предпочитаю, когда методы полностью самодокументируют, но иногда у Вас будут стандарты кодирования, которые передают под мандат внешнюю документацию, и затем инструмент как это сохранит Вас большой ввод braindead.
Можно использовать фрагменты кода для вставки любых строк, которые Вы хотите.
кроме того, при вводе трех единственных кавычек ('' ') на строке выше функционального заголовка она вставит шаблон заголовка XML, который можно тогда заполнить.
Эти XML-комментарии могут быть интерпретированы программным обеспечением документации, и они включены в вывод сборки как файл assembly.xml. Если Вы сохраняете тот XML-файл с DLL и ссылкой, что DLL в другом проекте, те комментарии становятся доступными в intellisense.
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 ++, Тип: Рефакторинг, затем перейдите к «Метод документа» и выполните настройку. Приведенный выше пример сгенерирован:
