2012-02-07 4 views
2

У меня есть проект C#, который мне нужно документировать с помощью doxygen. Он поднимает комментарии, автогенерируемые visual studio's ///, но, к сожалению, он не подбирает нормальные комментарии //. Есть ли настройка конфигурации, которую мне не хватает? Или это просто невозможно?// комментарии в doxygen

ответ

6

///XML Documentation Comments. Вот как Doxygen и другое программное обеспечение для создания документации располагают областями кода, которые вы хотите для использования в качестве документации.

Чтобы разработать, если у вас есть комментарии, например // This is hacky, but I'll return to it later, вы должны поменять их на раздел комментария XML по рассматриваемому методу, свойству или объекту.

+0

Хорошо, что имеет смысл. – Tim

2

Для меня это не ошибка, а функция. Есть комментарии, которые я хочу оставить в коде, а не извлекать и показывать всем. Различие между /// и // позволяет мне это сделать.

Смежные вопросы