文件名称:Doxygen使用教程
文件大小:2.35MB
文件格式:PDF
更新时间:2019-04-24 11:48:40
Doxygen C++ 代码注释 制作开发文档
Doxygen 是一个程序的文件产生工具,可将程序中的特定批注转换成为说明文件。通常我们在写程序时,或多或少都 会写上批注,但是对于其它人而言,要直接探索程序里的批注,与打捞铁达尼号同样的辛苦。大部分有用的批注都是 属于针对函式,类别等等的说明。所以,如果能依据程序本身的结构,将批注经过处理重新整理成为一个纯粹的参考 手册,对于后面利用您的程序代码的人而言将会减少许多的负担。不过,反过来说,整理文件的工作对于您来说,就 是沉重的负担。 Doxygen 就是在您写批注时,稍微按照一些它所制订的规则。接着,他就可以帮您产生出漂亮的文档了。 因此,Doxygen 的使用可分为两大部分。首先是特定格式的批注撰写,第二便是利用 Doxygen 的工具来产生文档。