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

Question

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

Answer 1

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

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

Answer 2

我说它几乎与语言无关。您记录了您想要记录的成员。

Answer 3

您可以记录私有函数 - 我们会使用@internal来提供公共和开发人员文档。

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