- 1、本文档共24页,可阅读全部内容。
- 2、有哪些信誉好的足球投注网站(book118)网站文档一经付费(服务费),不意味着购买了该文档的版权,仅供个人/单位学习、研究之用,不得用于商业用途,未经授权,严禁复制、发行、汇编、翻译或者网络传播等,侵权必究。
- 3、本站所有内容均由合作方或网友上传,本站不对文档的完整性、权威性及其观点立场正确性做任何保证或承诺!文档内容仅供研究参考,付费前请自行鉴别。如您付费,意味着您自己接受本站规则且自行承担风险,本站不退款、不进行额外附加服务;查看《如何避免下载的几个坑》。如果您已付费下载过本站文档,您可以点击 这里二次下载。
- 4、如文档侵犯商业秘密、侵犯著作权、侵犯人身权等,请点击“版权申诉”(推荐),也可以打举报电话:400-050-0827(电话支持时间:9:00-18:30)。
- 5、该文档为VIP文档,如果想要下载,成为VIP会员后,下载免费。
- 6、成为VIP后,下载本文档将扣除1次下载权益。下载后,不支持退款、换文档。如有疑问请联系我们。
- 7、成为VIP后,您将拥有八大权益,权益包括:VIP文档下载权益、阅读免打扰、文档格式转换、高级专利检索、专属身份标志、高级客服、多端互通、版权登记。
- 8、VIP文档为合作方或网友上传,每下载1次, 网站将根据用户上传文档的质量评分、类型等,对文档贡献者给予高额补贴、流量扶持。如果你也想贡献VIP文档。上传文档
查看更多
基于Doxygen的代码注释规范
一、Doxygen系列软件介绍
1、Doxygen
Doxygen是一种开源跨平台的,以类似JavaDoc风格描述的文档系统,完全支持C、C++、Java、 HYPERLINK /view/459423.htm \t _blank Objective-C和IDL语言,部分支持PHP、C#。注释的语法与Qt-Doc、KDoc和JavaDoc兼容。Doxgen可以从一套归档 HYPERLINK /view/385166.htm \t _blank 源文件开始,生成HTML格式的在线类 HYPERLINK /view/7718.htm \t _blank 浏览器,或离线的LATEX、RTF参考手册。
Doxygen能将程序中的特定批注转换成为说明文件。它可以依据程序本身的结构,将程序中按规范注释的批注经过处理生成一个纯粹的参考手册,通过提取代码结构或借助自动生成的包含依赖图(include dependency graphs)、继承图(inheritance diagram)以及协作图(collaboration diagram)来可视化文档之间的关系, Doxygen生成的帮助文档的格式可以是CHM、RTF、PostScript、PDF、HTML等。
2、graphviz
Graphviz(Graph Visualization Software)是一个由ATT实验室启动的开源工具包,用于绘制DOT语言脚本描述的图形。
要使用Doxygen生成依赖图、继承图以及协作图,必须先安装graphviz软件。
3、HTML Help WorkShop
微软出品的HTML Help WorkShop是制作CHM文件的最佳工具,它能将HTML文件编译生成CHM文档。
Doxygen软件默认生成HTML文件或Latex文件,我们要通过HTML生成CHM文档,需要先安装HTML Help WorkShop软件,并在Doxygen中进行关联。
二、软件下载与安装
Doxygen下载(doxygen-1.8.7-setup.exe):
HYPERLINK http://www.stack.nl/~dimitri/doxygen/download.html http://www.stack.nl/~dimitri/doxygen/download.html
graphviz(for windows)下载:
HYPERLINK /Download..php /Download..php
HTML Help WorkShop(1.32)下载:
HYPERLINK /download/0/a/9/0a939ef6-e31c-430f-a3df-dfae7960d564/htmlhelp.exe /download/0/a/9/0a939ef6-e31c-430f-a3df-dfae7960d564/htmlhelp.exe
软件安装都选择默认方式,点击下一步直至安装完成。
安装完后进行Doxygen配置时需要关联graphviz和HTML Help WorkShop的安装路径。
三、软件配置使用
我们的所有配置都在Doxywizard中进行,生成参考手册是通过运行Doxywizard得到。
(1)Wizard-Project最重要的是工作目录,源代码目录,生成参考文件目录三处的设定,其它项目名称、项目简介、版本和标识可以依照实际情况选填。
工作目录是新建的一个目录,在配置完成之后可以把配置文件存在这个目录里,每次从这个目录中导入配置文件(.cfg),然后进行说明文档生成。
源代码目录和最终的结果目录在每一次运行Doxywizard时都进行设定。
(2)Wizard-Mode 选择编程语言对应的最优化结果,按照编程语言选择。
(3)Wizard-Output 选择输出格式,选HTML下的(.chm)项,为最后生成chm做准备。由于不需要LaTeX结果,不选此项。
(4)Wizard-Diagrams 选择dot tool项,通过GraphViz来作图。
(5)Expert- Project 选择输出目录,选着输出语言。如果代码中采用了中文注释,此处选择为中文。
向下拉滑条,看见有JAVADOC_AUTOBRIEF和QT_AUTOBRIEF两个框,如果勾选了,在这两种风格下默认第一行为简单说明,以第一个句号为分隔;如果不选,则需要按照Doxygen的指令@brief来进行标准注释。
(6)Expert- Input 将输入编码方式改为GBK方式,确保输出中不会由于UTF-8方式导致乱码。
?最后也是经常遇到的问题就是DoxyGen生成的CHM文件的左边树目录的中文变成了乱码。这个 只需要将chm索引的编码类
您可能关注的文档
最近下载
- 人教版英语八年级上Unit3整单元课件(共190张ppt).ppt
- 茶叶加工工(高级、三级)理论考试复习题库(含答案).docx
- 数据通信基础认知—数据通信系统的基本概念.pptx
- 2024年宠物食品行业分析报告:从零食到主粮,从代工依赖到海内外均衡发展.pdf
- 床上用品供货及售后服务方案.docx VIP
- 一种双偏振雷达降水优化反演方法.pdf VIP
- 亲子农场体验园设计.pptx
- 刘京焕财政学模拟测试题.doc VIP
- 荣威-360-产品使用说明书-荣威360PLUS 1.5L 自动尊享版-CSA7154ADAC-荣威360用户手册-2018.7.11.pdf
- 财政学原理刘京焕陈志勇李景友第十章节.ppt
文档评论(0)