Doxygen使用备忘录

Doxygen可生成项目的API文档,注释详尽的话,完全可作为程序员的开发文档编制工具。Doxywizard是Doxygen的图形化设置和生成软件,下载地址: http://www.stack.nl/~dimitri/doxygen/download.html 要使用Doxygen,源代码中的注释需符合以下规范:

注释格式说明备注
/** … */ 要文档化的注释
/**< … */枚举型注释生成后标识符与注释内容位于同一行
– text…无序列表出现“-”的行与上一行之间不能留空行
@code
...
@endcode
注释中的代码(示例
@file档案(文件)的说明
@author作者信息
@brief类或函数的简易说明
@param参数解释后接空格、参数名及其说明
@return描述返回值
@note注解
@attention注意
@warning警告
@class引用某个类也可直接写出类名
@exception可能产生的异常描述

上表:Doxygen常用语法

Doxygen可生成整个API文档的“首页”。办法是:

1. 在源代码所在的目录下添加一个文本文件,比如“DesignDocument.h”。文件名和扩展名任选,只要保证Doxygen生成文档时能读取该文件。可将该文件加到项目中。而后在IDE中随时修改。

2. 该文件的格式:

注意:图片的路径基于API文档生成后所位于的目录,而非基于源代码目录,也非基于Doxygen项目文件所位于的目录。图片需要提前准备好。建议不要将图片置于Doxygen所生成的文档根目录下。因为有可能频繁重新生成,而生成之前有可能手工全部删除已经生成的所有文件(防止某些类改名后,有冗余无用的html文件),这会导致不经意间将图片文件误删。

3. 首页生成目录项(即页内跳转)的步骤有二:


@section 全局数据
<a name = 全局数据></a>


@section 目录
– <a href = #全局数据>全局数据</a>

依次类推,将所有需要跳转的目录设置好。

此外需注意:要Doxygen文档化的源码文件的格式需设置为UTF-8,否则生成乱码。以VS为例,更改源码文件的格式:IDE中打开源代码文件,另存为,编码格式选择UTF-8带签名。

SwingCoder

如果本文对您有所启发或助益,请微信打赏

创作时间: 2010.10.07 23:26
最后修改: 2017.05.10 15:28

本文版权:UnderwaySoft   共享协议:署名-非商业使用-禁止演绎


上一篇: Music++音乐制作与打谱软件
下一篇: 《周易》其实是儿童启蒙读物

 随机推荐:
Email: underwaySoft@126.com 微信公众号: UnderwaySoft