Doxygen心得.pdf

2010/10/20 Doxygen心得(转)_深蓝的天空_百度空间 用户名: 密码: 登录 注册 Read a lot and make trip further... 博客博客 | | 主页 博客博客 相册 个人档案 好友 查看文章查看文章 查看文章查看文章 Doxygen ( ) 2009-12-24 15:25 心得 转 doxygen是一款源代码帮助文档生成工具。依靠源代码中的注释，doxygen可以轻松的生成多种格式的帮助文档，供 开发者阅读。 doxygen 的使用方法很简单： 第一步，需要修改源代码文件，规范现有注释。为了使注释轻松智能的变成可读的文档。doxygen规定了自己 的注释格式，这样太才可以解析。最常用的注释格式是： /** there is comment. */ 或 /*! there is comment. */ 同时，为了区分注释的用途，doxygen定义了很多关键字，用来标识注释描述的代码段或者用途。常用@后面跟用 doxygen ( Special Commands ) 途关键字来标识，关键字在 附带的帮助文件中有很详细的解析 在 这一节中 ，这里就不 在累赘了。这里有一个地方需要注意一下，描述的各个分段之间最好用tab空开，用空格有的时候会出现问题。 如： /** * @brief 这是一个函数 * @param a 参数一 * @param b 参数二 * @return 无返回值 */ void fooFun(int a, int b); 第二步，建立doxygen配置文件。doxygen执行的时候需要一个配置文件，即每生成一个chm都会有一个配置文件来 doxygen DoxyWizard 进行生成工程具体信息的描述。 手工编写那个配置文件比较繁琐，还好 随身附带了一个 ，利用 这个向导。你可以方便的配置想要的信息。注意 DoxyWizard仅仅是一个界面，他最终编译的时候还是执行了 doxygen.exe ，传输时不要只拷贝这一个文件。 打开DoxyWizard，会发现DoxyWizard分成了三个区域。 在step1 中有三个按钮。 按钮[Wizard...]里面配置项目的一些基本信息 按钮[Expert...]包含高级配置信息 按钮[Load...]加载一个doxygen配置文件