doxygen的文档生成,注释规范

1.怎么利用别人提供的规法代码和配置文件生成注释文档

很多官方的协议栈和库都是按照doxygen的注释规范编写的,当我们拿到整个项目的时候,通常会有documentation目录或者doc目录,打开此目录通常会有doxygen目录和一个Doxyfile文件或者Doxyfile.cfg文件,这个就是doxygen的配置文件;安装好doxygen后,点击file->open,选择找到的配置文件。


上图是RT-Thread的库项目工程
通常配置文件会把所以相应的配置项配置好,可以直接运行生成注释文档。我们可以看到destination directory 选项框中是一个“.”表示的文件的输出目录是doxygen的工程目录,即step1指示的目录。为了文件的整洁和不破坏原来的文件组织结构,我们可以在doxygen的工程目录下建一个文件夹用来保存输出文件,例如建立一个doc文件夹,最后就是点击左侧的run表项中的run doxygen按钮就可以生成文档了。

2.doxygen的注释编写规范



评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值