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