VS xml документация, наследующая от базового класса

Question

Я включил создание документации XML в моей библиотеке классов, в которой есть один родительский класс и много унаследованных классов.Есть несколько свойств, переопределенных из свойств базового класса.Я хотел бы поместить комментарии XML к свойствам базового класса и получить те же комментарии к переопределенным свойствам.К сожалению, когда я генерирую XML Doc файл, комментарии по переопределенным свойствам отсутствуют.Можно ли переопределить комментарии xml из базового класса?

Answer 1

В зависимости от инструментов, которые вы используете для создания внешней документации (Doxygen, Sandcastle и т. Д.), Вы можете использовать include или аналогичный элемент для извлечения документации из других мест, чтобы ее можно было использовать совместно.

Другой подход заключается в использовании see, seealso или sa записей (опять же, в зависимости от инструмента, с которым вы обрабатываете комментарии к документации) для ссылки на свойство / метод базового класса, но это будет означать гиперссылку на базовая запись, не вложенная документация.

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