doxygen注释详解附有生成文档的对照PPT学习教案

1、会计学1 doxygen注释详解附有生成文档的对照注释详解附有生成文档的对照 第1页/共38页 第2页/共38页 第3页/共38页 第4页/共38页 第5页/共38页 新建一个系统变量名为新建一个系统变量名为”GBK”GBK”, 这我固定了这我固定了.所以都以这个名字所以都以这个名字. 这个就是要放置这个就是要放置iconviconv、 frfr工具里工具里 文件的路径文件的路径.(.(这个路径随自己编写这个路径随自己编写) ) 、 第6页/共38页 第7页/共38页 TEST |- src | | | |- test.c | |- test.h | |- doc | | | |- Doxyf

2、ile | |- doxygenWD.bat 第8页/共38页 第9页/共38页 项目名称，将作为于所生成项目名称，将作为于所生成 的程序文档首页标题的程序文档首页标题. . 文档版本号，可对应于项目文档版本号，可对应于项目 版本号版本号 . . 存放要生成项目文档的项目存放要生成项目文档的项目 源文件路径源文件路径. . 如果选上，就会连子文件夹的如果选上，就会连子文件夹的 文件一起生成文当。没选，就文件一起生成文当。没选，就 只会生成本文件夹的文件文档只会生成本文件夹的文件文档. . 这里填入生成文档文件输出这里填入生成文档文件输出 路径路径, ,这里只填文件夹名字这里只填文件夹名字 就可

3、以了就可以了. .为了大家工作方为了大家工作方 便便, , 就规定统一写就规定统一写outputoutput文件夹文件夹 第10页/共38页 选择这个选择这个, ,只生成文档实体只生成文档实体, , 不会生成源文件文档不会生成源文件文档. . 选择这个选择这个,会生成全部实体会生成全部实体.因因 此此,要选择这个要选择这个. 选择这个选择这个, ,把源文件内容导入把源文件内容导入 到项目文档里到项目文档里.(.(建议选择建议选择) ) 选择项目文档输出格式选择项目文档输出格式,测试测试 C语言语言,就选择个就选择个. 第11页/共38页 生成普通模式的生成普通模式的HTMLHTML 生成文件列

4、表格的生成文件列表格的HTMLHTML 生成生成chmchm文件格式的文件格式的 HTML,HTML,因此因此, ,就选这个就选这个. . 附带查找功能附带查找功能, ,一般不选一般不选 择择. . 这项没用到这项没用到, ,因此把它选因此把它选 择取消择取消. . 这三项不要选择这三项不要选择 第12页/共38页 这两个不选择这两个不选择. . 全选择全选择. .通过这个通过这个GraphVizGraphViz工具生工具生 成图表成图表: : (1).(1).类的图表类的图表. . (2).(2).协作图表协作图表. . (3).(3).包含文件图表包含文件图表( (调用图表调用图表).).

5、 (4).(4).被包含文件图表被包含文件图表( (被调用图表被调用图表 ).). (5).(5).整个类层次结构图表整个类层次结构图表. . (6).(6).调用图表调用图表( (函数函数, ,文件文件).). 第13页/共38页 第14页/共38页 DOXYFILE_ENCODINGDOXYFILE_ENCODING是是DoxyfileDoxyfile的的 文本编码。如果文件中有中文字文本编码。如果文件中有中文字 符，可以填写符，可以填写GBKGBK。把。把UTF-8UTF-8改为改为 GBKGBK。 输出语言相当于程序资源，选择输出语言相当于程序资源，选择 ChineseChinese。

6、 第15页/共38页 取消选项取消选项, ,不然会不然会 显示全路径显示全路径: :如图如图 1.1. 图图1 1 第16页/共38页 将将WARN_LOGFILEWARN_LOGFILE填写为填写为error.txterror.txt 。这样，。这样，DoxygenDoxygen会将编译时出现会将编译时出现 的警告和错误保存在的警告和错误保存在error.txterror.txt ， 这样可以对照修改。这样可以对照修改。 让让 doxygen doxygen 静悄悄地为你生成文静悄悄地为你生成文 档，只有出现警告或错误时，才档，只有出现警告或错误时，才 在终端输出提示信息在终端输出提示信息(

7、 (不选择不选择).). 第17页/共38页 指定输入源文件目录（指定输入源文件目录（INPUTINPUT） . . 输入文件编码（输入文件编码（INPUT_ENCODINGINPUT_ENCODING）改）改 为为GBK.GBK. 对文件过滤选项对文件过滤选项, ,我们这里只填我们这里只填* *.c .c * *.h.h. 第18页/共38页 可以通过参数可以通过参数HTML_HEADERHTML_HEADER和和HTML_FOOTERHTML_FOOTER 定制页面，参数值是包含定制内容的文件定制页面，参数值是包含定制内容的文件 名名. .这里我填了这里我填了html_foot html_

8、foot 文件文件, ,内可以打内可以打 开开html_foot html_foot 文件看文件看. . 这里只看效果图这里只看效果图: :如如 图图2.2. 选择选择GENERATE_HTMLHELPGENERATE_HTMLHELP后，后，DoxygenDoxygen 会准备生成会准备生成chmchm文件需要的项目文件、文件需要的项目文件、 目录文件和索引文件目录文件和索引文件。 图图2 2 第19页/共38页 可以选上可以选上UML_LOOKUML_LOOK、CALL_GRAPHCALL_GRAPH和和 CALLER_GRAPHCALLER_GRAPH。CALL_GRAPHCALL_GR

9、APH是本函是本函 数调用其它函数的示意图数调用其它函数的示意图. .效果如效果如: : 图图3.3. 图3 第20页/共38页 第21页/共38页 / /* * * * */ /这是固定格式，还要注意这是固定格式，还要注意/ /* * * 这这2 2个个“* * *”不能少也不能多。其他注不能少也不能多。其他注 释风格也是这样的。释风格也是这样的。 “nn”作用是回车换行作用是回车换行. . “brief ”是注释指令, “” 也可以用”. 第22页/共38页 类型：类型：enum enum ，structstruct 注意，要以 “” 小于号开头 ，如过不 用“”，那这行的注释就会被 Doxygen认为是成员2的注释。 第23页/共38页 第24页/共38页 Doxygen生成效果 第25页/共38页 第26页/共38页 第27页/共38页 第28页/共38页 第29页/共38页 第30页/共38页 第31页/共38页 “:”是指定有连