Шаблон комментария в VS2010 - PullRequest
       40

Шаблон комментария в VS2010

2 голосов
/ 15 сентября 2011

Я унаследовал API, который не имеет надлежащих комментариев, и я работаю над его изменением.

Кто-нибудь знает, существует ли какой-нибудь механизм добавления XML-комментариев по умолчанию ко всем членам класса или сборки? (Я помню, что видел что-то подобное в веб-трансляции, и я думаю, что он мог бы использовать сценарий PowerShell для этого.)

Таким образом, я могу избежать множества повторяющихся шагов, и у меня есть все, что нужно, чтобы начать писать только комментарии.

У кого-нибудь есть предложения получше?

Ответы [ 2 ]

3 голосов
/ 15 сентября 2011

Я считаю, что GhostDoc довольно хорош.

После того, как вы запустите его поверх своего кода, вы просто добавляете детали, где это необходимо.

http://submain.com/products/ghostdoc.aspx

3 голосов
/ 15 сентября 2011

GhostDoc отлично подходит для XML-документации, хотя вам необходимо приобрести копию, чтобы сгенерировать автоматическую документацию для всех классов / членов.Бесплатная версия позволяет вам щелкнуть правой кнопкой мыши (или использовать горячую клавишу) на классе или члене, и он сгенерирует документацию.

...