// комментарии в doxygen

Question

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

Answer 1

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

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

Answer 2

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