工作当中需要格式化文档,在编码的同时要写文档.
本来是件蛮辛苦的工作,但是因为有了Doxygen这个工具,一切变得简单了很多.
用下来,Doxygen这个工具还是很好很强大的,除了注释起来比较简单,我习惯用://!的方式.而且还支持许多特殊的命令.
同时,加上html和graphic这两个工具,可以很方便的生成带有类图的chm文档.
以下是这两天研究中的一些心得,记录下来:
1.
很灵活,有多种的形式可以选用.
/*! */ /** */ //! ///
2.
Doxygen函数注释部分放在头文件里面即可.放在CPP函数体中也可以,但是这样不大清晰,还是在头文件中定义.
本来是件蛮辛苦的工作,但是因为有了Doxygen这个工具,一切变得简单了很多.
用下来,Doxygen这个工具还是很好很强大的,除了注释起来比较简单,我习惯用://!的方式.而且还支持许多特殊的命令.
同时,加上html和graphic这两个工具,可以很方便的生成带有类图的chm文档.
以下是这两天研究中的一些心得,记录下来:
1.
很灵活,有多种的形式可以选用.
/*! */ /** */ //! ///
2.
Doxygen函数注释部分放在头文件里面即可.放在CPP函数体中也可以,但是这样不大清晰,还是在头文件中定义.