在实现文件中包含注释类声明

Question

每个人都知道更易读的代码的优点.因此,为了使我的代码更具可读性,我通常在该类的实现文件中包含注释类声明.
这样我就不必浏览各种include目录来定义.
那么,这是一个很好的做法还是只是过度记录？
如果有一些标准技术,请告诉我.
编辑:
有没有办法从Vim中的实现迁移到类声明？
除了在新缓冲区中打开它.

谢谢

Answer 1

这实际上是适得其反的,因为现在在修改类声明时必须更改三个位置而不是两个位置,并且编译器不会检查其中一个位置以捕获任何不匹配.

此外,在大型且快速发展的项目中,评论总是过时,因此无法信任.

所有现代IDE都可以通过多种方式帮助从类实现中访问类声明,所有这些方法都比滚动到文件顶部然后返回更方便.

作为替代方案,请考虑使用自动文档工具,如doxygen.可以告诉Doxygen在文档中包含整个类声明 - 包括语法突出显示,行号和源文件的链接.您可以在构建过程中包含doxygen传递,并始终拥有最新的代码参考.