Как автоматически генерировать комментарии в Visual Studio 2010 и C #? - PullRequest
35 голосов
/ 14 марта 2011

Из Eclipse я привык, что когда я начинаю вводить комментарий для класса или метода, параметры, возвращаемые типы и исключения генерируются автоматически.Но в VisualStudio 2010 я не могу найти что-то подобное.Любые намеки, как этого добиться?

Ответы [ 5 ]

96 голосов
/ 14 марта 2011

Единственный способ, которым я знаю, это сделать в строке прямо над вашим методом, просто наберите "///", и он сгенерирует шаблон комментария на основе метода.

10 голосов
/ 14 марта 2011

GhostDoc - это бесплатное расширение, которое сделает это. Просто нажмите (по умолчанию) Ctrl + D в любом месте метода, и он добавит комментарии к документации XML с заполненными значениями по умолчанию (хотя обычно их следует изменять / расширять).

6 голосов
/ 14 марта 2011

Используйте «///» вместо «//» для комментариев.Например, следующий комментарий был сгенерирован автоматически, просто набрав «///»:

/// <summary>
/// </summary>
/// <param name="terms"></param>
public TVec(IEnumerable<Term> terms)
{
}
2 голосов
/ 14 марта 2011

Попробуйте набрать "///" на одну строку перед методом. Скажи мне, если это то, что ты ищешь.

1 голос
/ 14 марта 2011

Вы можете использовать Ghostddoc для генерации множества ваших xml комментариев: http://submain.com/products/ghostdoc.aspx

Я думаю, что есть бесплатная версия.

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...