Doxygen 中文使用文档 及 适合Doxygen的 注释宏

时间:2015-05-01 05:19:15
【文件属性】:

文件名称:Doxygen 中文使用文档 及 适合Doxygen的 注释宏

文件大小:148KB

文件格式:RAR

更新时间:2015-05-01 05:19:15

Doxygen 注释宏 统一注释格式

Doxygen 中文使用文档 及 适合Doxygen的注释宏 使注释更简单 统一 注释宏 已经过修改 使用简单方便 Doxygen 是一个程序的文件产生工具,可将程序中的特定批注转换成为说明文件。通常我们在写程序时,或多或少都会写上批注,但是对于其它人而言,要直接探索程序里的批注,与打捞铁达尼号同样的辛苦。大部分有用的批注都是属于针对函式,类别等等的说明。所以,如果能依据程序本身的结构,将批注经过处理重新整理成为一个纯粹的参考手册,对于后面利用您的程序代码的人而言将会减少许多的负担。不过,反过来说,整理文件的工作对于您来说,就是沉重的负担。   对于未归档的源文件,也可以通过配置Doxygen来提取代码结构。或者借助自动生成的包含依赖图(includedependency graphs)、继承图(inheritance diagram)以及协作图(collaborationdiagram)来可视化文档之间的关系。Doxygen生成的帮助文档的格式可以是CHM、RTF、PostScript、PDF、HTML和Unixman page等。   一个好的程序设计师,在写程序时,都会在适当的地方加上合适的批注。如果,能够在撰写批注时,稍微符合某种格式,接着就可以透过一个工具程序依据程序结构及您的批注产生出漂亮的文件。这将令许多工作繁重的程序设计师有时间多喝几杯咖啡。   Doxygen 就是这样的一个工具。在您写批注时,稍微按照一些它所制订的规则。接着,他就可以帮您产生出漂亮的文件了。因此,Doxygen 的使用可分为两大部分。首先是特定格式的批注撰写,第二便是利用Doxygen的工具来产生文件。


【文件预览】:
COMMENT.vb
Doxygen使用简介.docx

网友评论

  • 好东西。不过自己还要好好学习。
  • 感觉不是很详细。。。