我应该在C ++中评论声明或定义吗？

Question

评论，声明（在头文件中）或定义（在源文件中）哪个更实用？也许我应该评论两者，或者不评论，并将它们全部放在一个单独的文件中......

Answer 1

您应该完全记录优先级最高的头文件。

定义中的注释应该集中在实现细节上，而标题注释应该集中在界面上。

如您所建议的，第三个文档来源也很有用。它应该描述整体概念。

评论头文件的一大优点是，如果您遵循一些简单的语法，您可以自动创建文档。跟doxygen问好！

Answer 2

取决于评论所说的内容，以及您希望阅读的内容。

Answer 3

我想添加ypnos的答案：

您的评论取决于您的观众是谁。将您的代码视为封闭源代码在这方面有所帮助：维护者可以看到实现，客户/用户只能看到界面。如果用户需要注释，则必须进入界面。如果评论仅与给定的实现相关，则可能只需要进入实施（但不一定，取决于您的受众）。