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

Question

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

Answer 1

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

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

Answer 2

我会说这几乎是与语言无关的问题。您记录想要记录的成员。

Answer 3

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

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