每个人都知道代码更具可读性的优点。因此，为了使我的代码更具可读性，我通常会在该类的实现文件中包含注释类声明。
这样我就不必浏览各种包含目录来找到定义。
那么，这是一个好的做法还是只是过度记录？
如果有一些标准技术，请告诉我。
编辑:
有没有办法从 Vim 中的实现迁移到类声明？
除了在新缓冲区中打开它。
谢谢
最佳答案
这实际上适得其反，因为现在您在修改类声明时必须更改三个 位置而不是两个，并且编译器不会检查其中一个位置以捕获任何不匹配。
此外，在大型且快速发展的项目中，评论总是会过时，因此它们不可信任。
所有现代 IDE 都可以通过多种方式帮助从类实现访问类声明，所有这些方式都比滚动到文件顶部然后返回更方便。
作为替代方案，请考虑使用自动记录工具，例如 doxygen . Doxygen 可以被告知在文档中包含整个类声明——带有语法高亮、行号和源文件链接。您可以在构建过程中包含 doxygen pass，并始终拥有最新的代码引用。
关于c++ - 在实现文件中包含注释类声明，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/1750514/