Doxygen评论私人会员和免费功能？

Question

我应该使用Doxygen评论私人会员和免费功能？我来自Java世界，并且我从未将Javadoc添加为私有成员。这是C++世界中可接受的做法吗？

Answer 1

我会说这几乎是独立于语言的问题。你记录你想要记录的成员。

Answer 2

取决于文档目标受众。如果它是公开发布的，那么不，他们不需要知道私有和内部变量。

如果是内部使用，那么他们肯定需要知道私有变量和自由函数的用法。

Answer 3

您可以记录私人功能 - 我们可以使用@internal来提供公共和开发者文档。

我们还使用私有实现实践，其中实现对用户是隐藏的。