Комментарии XML для абстрактных методов в Visual Studio 2008 - PullRequest
5 голосов
/ 30 июня 2009

Скажем, у вас есть абстрактный класс с абстрактными методами, и вы размещаете теги XML-документации в этих методах.

Когда вы наследуете от этого класса и реализуете эти методы, intellisense не «наследует» документацию XML ...?

Кто-нибудь знает, возможно ли заставить IDE наследовать документацию?

если нет, не думаете ли вы, что это странное поведение?

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

Ответы [ 2 ]

3 голосов
/ 30 июня 2009

GhostDoc автоматически унаследует документацию. Это мой любимый плагин № 2 рядом с ReSharper.

Ctrl + Shift + D ... задокументировано!

0 голосов
/ 03 июля 2009

Вы не можете получить документацию по наследству - вам необходимо явно документировать каждый элемент кода.

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

...