近段时间,一直在学习华为C语言编程规范(2011版),在“注释”这一章中发现了一种“Doxygen”的注释转文档工具,查看诸多相关资料,并进行编程实践,终于可以利用Doxygen给C程序生成注释文档.在使用过程中,我已经深深地喜欢Doxygen,并在写代码时使用Javadoc注释风格. 本文由三部分组成:1)工具下载及安装:2)编写Doxygen可识别的注释:3)利用Doxygen工具将注释转换成API文档. 1.工具下载及安装 (1)Doxygen可以从一套源文件开始,生成HTML格式的在线类

接触Doxygen后,认识到其强大之处,一口气将之前的烂代码重构了一遍,所有的文件头,函数注释等等都是手动添加注释.在keil中可以看到其对JavaDoc风格的注释有高亮,非常好看.但是keil这个IDE作为编译器和调试工具,好用的没话说,作为编辑器却非常不能与时俱进.自动补全,代码缩进都超烂.找了很多编辑器,像sublime,Atom,VS code等,又缺少跨文件的补全,go to definition等功能.vim和emacs学习曲线又太长.同事提到可以试试Qt Creator看看,于是我

Windows下使用doxygen阅读和分析C/C++代码 转自:http://blog.sina.com.cn/s/blog_63d902570100gwk6.html 虽然使用各种IDE或者Source Insight 可以方便地在windows下阅读和分析C/C++代码,但是一步步Go to Definetion 实在令人痛苦.Doxygen能够生成函数调用关系图,所有的函数调用关系可以一目了然,另外他还能统计文档中所有的类,成员变量,成员函数等.总的来说,Doxygen不但能从局部把握代

http://blog.csdn.net/lostaway/article/details/6446786 Doxygen 是一个支持 C/C++,以及其它多种语言的跨平台文档生成工具.如同 JavaDoc, doxygen 直接从源文件中提取符合 doxygen 注释规范的注释,生成文档[1]. 1.安装 1.1 安装 Doxygen 1.7.4(Windows) 地址:ftp://ftp.stack.nl/pub/users/dimitri/doxygen-1.7.4.windows.bin

1.安装 sudo apt-get install doxygen按tab键 doxygen        doxygen-dbg    doxygen-doc    doxygen-gui    doxygen-latex 安装doxygen   doxygen-gui 2.生成源代码注释文档 doxywizard 出现图形界面,根据图形界面提示就可以了. 3.学习doxygen 安装doxygen-doc后,会在/usr/share/doc/doxygen目录下有文档和例子.

在一个应用的整个开发过程中涉及到了无数的步骤.其中一些是应用的说明,图片的创作,应用的实现,和实现过后的测试阶段.写代码可能组成了这个过程的绝大部分,因为正是它给了应用生命,但是这样还不够,与它同等重要的还有代码的注释和文档编写.不管代码写的有多好,如果缺少了对应的好的注释文档,很有可能在将来带来麻烦.不幸的是,许多开发者都忽视或忽略了代码文档的重要性,而这非常糟糕,因为好的程序不仅仅是好的代码.它需要更多的东西. 谈到编写注释文档,显然我不是说仅仅简单的在实现文档里添加几行注释.肯定是更多的东

1.  下载与安装 1.1 下载 Doxygen官方安装程序及其手册下载地址,目前使用版本为1.8.8. 安装程序:http://www.stack.nl/~dimitri/doxygen/download.html 图 1-1 Doxygen安装程序下载界面 在线帮助:http://www.stack.nl/~dimitri/doxygen/manual 图 1-2 Doxygen帮助文档下载界面 GraphViz Doxygen官方安装下载地址及其在线帮助地址,目前使用版本为2.38. 安装

Bullet 全称 Bullet Physics Library,是著名的开源物理引擎(可用于碰撞检测.刚体模拟.可变形体模拟),这里将bullet的学习资源整理一下,希望能帮助入门者少走弯路. 看下wikipedia的介绍还是必要的: http://en.wikipedia.org/wiki/Bullet_(software) 看完才知道,好多大片都用的Bullet做物理模拟,如电影<2012>,这应该能增加你对Bullet的兴趣吧. 官方网站: http://bulletphysics.o

1. Doxygen做什么? 首先这是一个文档生成工具,而不是代码中的注释生成工具.其次,如何生成对应文档,那就是按照一个配置文件中给出的配置格式来书写注释的时候,通过工具就可以解析代码注释最终生成文档.

原创文章,欢迎阅读,禁止转载.本文记一下javadoc风格注释的写法,这些特殊格式的注释称作标签.按照这种规范写的注释才能生成到文档中. 块注释的写法 /** * @brief 这个块注释 * doxygen标签就是写在这里(除了单行注释) * 格式为双星开始"/** ... */",标签可以写多行 */ 单行注释的写法 int var; ///< 用"///<"的是单行注释 int abc; ///< 常用于全局变量.成员变量.结构体成员.枚举值

原创文章,欢迎阅读,禁止转载. doxygen是个好用的文档生成工具,他的强大功能有很多介绍,我就不说了.自带的chm帮助手册很全面,包括功能.注释规范.怎么配置.工具用法等.doxygen的用法共3步:1. 按照注释规范对代码加注释.2. 配置选项.3. 生成文档.配置选项可以使用命令行工具 doxyfen -g 生成一个配置模版,我直接使用带界面的配置向导来配.向导中的三个选项卡:1. wizard 进行大致的配置选择2. expert 进行精细的配置3. run 生成文档配置界面第一步如图

使用doxygen制作C代码文档 C 代码注释风格约定 行间注释 /*! * * 这里是注释 * */ 行内注释 <code here> /*! 这里是注释 */ doxygen 风格的宏 宏名可以是'\'或'@'后面跟宏名组成.如:\brief 或 @brief 表示一个简要说明在doxygen生成的html中, 前部分显示概要信息, 该信息后有个"更多" ,点击跳转到详细说明. 宏名 宏名 宏名 宏名 宏名 宏名 宏名 宏名 宏名 宏名 宏名 宏名 宏名 宏名 宏名 宏

Xcode5有个新特性就是自己定义的函数也会被检测集成到代码提示里面,也就是在Quick Help有提示.如 /** * @brief 设置id * * @param id 要设置的id */ +(void) setUserID:(NSString *)id { NSUserDefaults *userDefaults = [NSUserDefaults standardUserDefaults]; [userDefaults setObject:id forKey:@"userID"

作者:zyl910 v1.1版的改动如下—— 将源码上传到github. 调整目录结构. 添加CMake编译配置文件. 使用doxygen规范注释. 文件清单—— docs\ docs\images\ docs\images\examples_tcharall.png examples\ examples\tcharall\ examples\tcharall\makefile examples\tcharall\tcharall.c examples\tcharall\tcharall_200

新版本—— http://www.cnblogs.com/zyl910/p/zlstdint_v100.html[C] zlstdint(让VC.TC等编译器自动兼容C99的整数类型)V1.0.支持Turbo C++ 3等DOS下的编译器 作者:zyl910 一.改动简介 V1.02版的改动如下—— 将源码上传到github. 调整目录结构. 添加CMake编译配置文件. 使用doxygen规范注释. 修正 __AUTO_STDINT_H_USESYS 误为 _INTTYPES_H_SYS_ 的

一． 什么是Doxygen? Doxygen 是一个程序的文件产生工具,可将程序中的特定批注转换成为说明文件.通常我们在写程序时,或多或少都会写上批注,但是对于其它人而言,要直接探索程序里的批注,与打捞铁达尼号同样的辛苦.大部分有用的批注都是属于针对函式,类别等等的说明.所以,如果能依据程序本身的结构,将批注经过处理重新整理成为一个纯粹的参考手册,对于后面利用您的程序代码的人而言将会减少许多的负担.不过,反过来说,整理文件的工作对于您来说,就是沉重的负担. Doxygen 就是在您写批注时,稍微

一.引子 用这两个工具可以自动的遍历代码,并且产生代码文档,我们先来看看效果,然后放出这两个工具的下载地址. 二.工具的下载地址 doxygen:http://www.stack.nl/~dimitri/doxygen/download.html graphviz:http://www.graphviz.org/ 三.使用步骤 首先安装doxygen,然后解压下载好的graphviz.接着打开doxygen,按照我下面的图示进行操作就好了. 最后点run就可以了. 附上doxygen能识别的一些

一.准备阶段 在之前的一系列文章中,我尝试了不同方法为Unity的C#生成脚本手册(帮助文档) 使用Doxygen生成C#帮助文档 为Unity项目生成文档(一)为Unity项目生成文档(二) 建议的文档注释标记(C# 编程指南) 今天查阅到一个更好的方法,可以直接在Unity中使用 二.Doxygen Tool 官方网站:http://www.jacobpennock.com/Blog/?p=629 Unity论坛:http://forum.unity3d.com/threads/free-p

Doxygen是一种开源跨平台的,以类似JavaDoc风格描述的文档系统,可以从一套归档源文件开始,生成chm格式的文档.本文主要讲解如何在winddows下安装doxygen.     1.下载doxygen-1.8.8-setup.exe,下载地址为:           1)官方地址:http://www.stack.nl/~dimitri/doxygen/download.html           2)华军软件:http://www.onlinedown.net/soft/11701

http://www.stack.nl/~dimitri/doxygen/index.html 非常的方便. 2步生成API文档. 具体信息见官网哟!