Как создать///резюме

Как создать эти резюме в Visual Studio?

/// <summary>
///  Returns a number
/// </summary>
/// <param name="num"></param>
/// <returns></returns>

Ответ 1

Введите /// перед вашим методом, свойством и т.д. VS автоматически сгенерирует блоки комментариев.

Ответ 2

Как уже говорили другие, Visual Studio по умолчанию автоматически добавляет шаблон документации, когда вы вводите три слэша в строке над объявлением участника. Если у элемента есть какие-либо атрибуты, применяемые к нему, введите черты в строке над атрибутами.

Обратите внимание, однако, что одна из самых полезных вещей для документа для метода (или конструктора, свойства и т.д.) - это исключения, которые может генерировать метод. Их можно добавить, набрав ///<exception после остальной документации. Когда вы принимаете предложение Intellisense, вам будет предоставлено место для типа Exception как атрибут XML, и вы можете заполнить обстоятельства в содержимом элемента исключений.

Если какие-либо параметры будут добавлены в метод после того, как документация уже будет создана, Intellisense также будет очень полезной при заполнении нового имени параметра, когда вы переходите к его добавлению в документацию. Это довольно гладкая функция.

Ответ 3

Используйте инструменты, такие как GhostDoc. Он будет генерировать, щелкнув правой кнопкой мыши имя метода.

Ответ 4

Я могу рекомендовать GhostDoc сделать это еще проще.

Ответ 5

тип три раза /, а Visual Studio заполнит остальную часть кода.

Ответ 6

Поместите курсор на строку перед методом или классом, который вы хотите документировать, и введите "///". Visual Studio будет генерировать теги XML doc, и вы можете заполнить детали.

Ответ 7

Как говорит Джордж,///на линии чуть выше будет автогенерировать ее.

Помимо шаблона комментариев шаблона, который он дает вам, я бы рекомендовал взглянуть на другие теги, которые вы можете использовать: http://msdn.microsoft.com/en-us/library/5ast78ax.aspx

Это можно использовать в сочетании с другими инструментами, такими как Sandcastle, для автоматического создания руководств CHM и т.д.

Ответ 8

В строке перед вашим свойством/методом /etc просто введите ///, а затем Visual Studio автоматически добавит теги XML.