没有合适的资源?快使用搜索试试~ 我知道了~
资源推荐
资源详情
资源评论
C++ 程序文档生成器介绍
(doxygen)
程序文档,曾经是程序员的一个头痛问题。写一个程序文档,比较花时间,但不是很难;麻烦
的是当程序修改后,程序文档也要跟着同步更新,否则文档和程序就要脱节,文档也就变成没
用的东西了。
好在有许多好用的文档生成器来解决这个问题。目前比较流行的 文档生成器是
。
本文就简单的介绍一下 的文档注释方法,以供初学者参考:
1.模块定义(单独显示一页)
模块名d模块的说明文字
定义的内容d
模块结尾
2.分组定义(在一页内分组显示)
分组说明文字
定义的内容d
3.变量、宏定义、类型定义简要说明
简要说明文字d
!"简要说明文字(在前面加d!"是标准格式)d
#$%&'$%(
分行的简要说明d)
这是第二行的简要说明
" !*
4.函数说明
简要的函数说明文字d
+",-参数 - 说明
+ ,.参数 . 说明
返回值说明
" /0" -1" .2*
打开文件d)
文件打开成功后,必须使用d3345"4函数关闭。
+",4&文件名字符串
+",4&文件打开模式字符串,可以由以下几个模块组合
而成:
6读取
67可写
6添加
6 文本模式0不能与d!联用2
6!二进制模式0不能与d 联用2
返回文件编号
66-表示打开文件失败
文件打开成功后,必须使用d3345"4函数关闭
示例3
/
用文本只读方式打开文件
" 8"4093)) 5 919 92*
/
533:"433;" "43345"4
/ 由于特殊的原因,这个函数可能会在将来的版本中取消。
" "40/5 /<4&1/5 /<4&2*
5.枚举类型定义
枚举常量d
=;>
?'%8(1@星期天(注意,要以d“@A小于号开头)d
#%8-1@星期一d
'B8.1@星期二d
;B=8C1@星期三d
D'8E1@星期四d
:$8F1@星期五d
?8G@星期六d
定义类型dB=;>
B=;>*
6.类的注释说明(实例)
文件的注释格式
注释文件格式文件名文件的简短注释
文件的详细注释
普通注释不会生成在文档中
!"#!$$%$&!"$&!$%'(
类的注释格式)简短注释内容
)*
+
*
,)
---函数的注释格式
---函数的注释格式)函数的简短注释
---)
---参数注释格式参数的简短注释
---**
---**
---返回值注释格式,返回值的简短注释
---,
---具体返回值的注释格式*返回值该返回值的注释
---*,
---*$ ./01
---*'
---参见格式参见的类文件等
---
---234
54
自定义类型的注释
),,
,
+
---行尾的注释格式6注释内容
---4---6
---4---67
54
全局变量的注释也可以采用上面的行尾格式进行注释
)*)
8$4
7. 配置文件的生成与修改
---1 的功能强大配置选项也十分多如果是命令行模式有些不便因此建议使用
9: 的 1;<2可以从6开始=菜单中运行3下面就对我个人认为比较重要的选项并结
合实例2生成 文档3进行简单说明
---下面列出的一般是需要修改的未列出的我采用缺省值
>? 选项
@/>A 是生成文档的项目名会显示在文档中
>0BCA/.DE----------8@/>A
>0BCA/.:E0--------8'$---项目版本号
生成文档的输出路径
B:/>:/ 0A/B0F------8GE1,G
生成文档的语言缺省是 也可以是简体中文等
B:/>:/HD.9:D9-------8
CDIDBAD:/B0 J-----8F@---打开此选项
,选项
@KBL .AH:J H@----8.B------不显示所有包括的文件
,选项
要生成文档的源文件的路径如果是一个目录则是该目录下的所有文件4当然也可以
是具体的某个文件
.>:/-----------------8GE1,G
输入文件的匹配模式下面是 MM语言的设置
J H>D//0.@---------8NO
------------------------NO
------------------------NO
------------------------N
0A:0@ I-------------8F@---需要递归处理子目录
,); 选项
如为 @B:0A0BL@0 和 .H .@B:0A@ 都设置为 F@则生成的文档中会包括
源代码
2即 文件3这可以方便阅读时查看源代码
@B:0A0BL@0--------8.B
.H .@B:0A@--------8.B
@/0 >ABABEE./@---8F@---忽略普通的文档注释
0J0.AF0HD/ B.8F@
0J0.A@0HD/ B.---8F@
I0D/ EKD0@------8F@
K/EH选项
剩余34页未读,继续阅读
资源评论
jiaoxiaogu
- 粉丝: 64
- 资源: 169
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功