Doxygen комментарии для частных пользователей и бесплатные функции?

Question

Должен ли я использовать комментарии Doxygen для частных пользователей и бесплатных функций? Я из мира Java и никогда не добавлял Javadoc для частных пользователей. Является ли это приемлемой практикой в ​​мире C ++?

Answer 1

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

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

Answer 2

Вы можете задокументировать частные функции - мы используем и используем @internal для предоставления общедоступной документации и документации для разработчиков.

Мы также используем практику частной реализации, когда реализации скрыты от пользователя.

Answer 3

Я бы сказал, что это в значительной степени не зависит от языка.Вы документируете участников, которые хотите документировать.