在 C++ 中创建公共头文件时,您认为最佳实践是什么?
头文件应该不包含、简短或大量的文档吗?我已经看到了从几乎没有文档(依赖于一些外部文档)到不变量、有效参数、返回值等的大型规范的所有内容。我不确定我到底喜欢什么,大型文档很好,因为你总是可以访问它来自您的编辑器,另一方面,带有非常简短文档的头文件通常可以在一两页文本上显示完整的界面,从而更好地概述类可以做什么。
假设我使用简短或大量文档之类的东西。我想要类似于 javadoc 的东西,我在其中记录返回值、参数等。c++ 中最好的约定是什么?据我所知,doxygen 在 java doc 样式文档方面做得很好,但是在使用 javadoc 样式文档之前我应该了解其他任何约定和工具吗?