Doxygen 注释应该写在哪里比较合适?
若写在声明
- 其他人在查阅时能更快理解
但是
- 一点小修改就需要重新编译
一般来说写在哪里比较合适呢?
一般都是写在声明的地方,因为声明的地方代码比较少,都是各种函数、类的定义,结合着注释就可以很容易的了解整个代码的大体功能,而实现的地方由于有很多细节的代码混杂在一起,反而不容易有一个全局的概念。
如果在意编译速度,可以考虑单独用一个头文件专门写 doxygen 文档,这个头文件不需要被任何地方 include,仅仅是给 doxygen 生成文档用的,它和实际代码用 @class
等 doxygen 关键字关联起来。
这样做的坏处就是文档和代码不对应,很容易出现代码更新了但忘记改文档的情况。总之是没有十全十美的方案,需要自己权衡啦。