编程技巧之doxygen注释

编程技巧之doxygen注释

一、为什么？是什么？

为什么：

• 养成良好的代码风格和代码习惯，有助于提高工程师的职业素养以及对于后续项目代码的维护与升级提供方便；

• 当一个项目的代码量到达一定量级的时候，不论是后续阅读以及返工调试修改的时候，在部分关键代码处（即使是自己亲手操刀的代码）也可能会有编写时和阅读时理解的偏差；

• 如果有工具可以在项目编写后自动生成API（函数说明）文档以及调用关系图等，那岂不是很形象。

是什么：

• 隆重介绍下：Doxygen文档生成工具+GraphViz图像生成工具
• Doxygen：在项目代码中，添加符合Doxygen规范的注释代码，即可通过Doxygen来产生函数说明文档等,例如:

• GraphViz：用来画图的工具，与doxygen结合，可自动生成函数之间的类图、调用与被调关系图等

安装教程和软件尽量走官网下载哈，都是免费的(●’◡’●)

二、小心得

• 不要太在意代码注释 ，是不是很奇怪，推荐注释工具又不建议太在意；

小小编一开始注释上头，一个个临时变量也要写个规范注释说明下，后来发现注释的工作量已超出了研发本身工作量，哈哈哈，最后深刻体会到主次之分以及是为什么要写注释，不能为了注释而注释，在关键点信息注释。

• 变量以及函数命名规范会极大方便代码维护和更迭。