Блог

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

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

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

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