C/C++学习ing。还是想要测试。

Doxygen 把c++注解生成文档

上一篇 / 下一篇  2011-11-15 11:08:52 / 个人分类:c++测试

Doxygen  简介

Doxygen 是一种开源跨平台的,以类似JavaDoc风格描述的文档系统,完全支持C、C++、Java、Objective-C和IDL语言,部分支持PHP、 C#。注释的语法与Qt-Doc、KDoc和JavaDoc兼容。Doxgen可以从一套归档源文件开始,生成HTML格式的在线类浏览器,或离线的 LATEX、RTF参考手册。

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

  对于未归档的源文件,也可以通过配置Doxygen来提取代 码结构。或者借助自动生成的包含依赖图(includedependencygraphs)、继承图(inheritancediagram)以及协作图 (collaborationdiagram)来可视化文档之间的关系。Doxygen生成的帮助文档的格式可以是CHM、RTF、 PostScript、PDF、HTML和Unixmanpage等。

  一个好的程序设计师,在写程序时,都会在适当的地方加上合适的批注。如果,能够在撰写批注时,稍微符合某种格式,接着就可以透过一个工具程序依据程序结构及您的批注产生出漂亮的文件。这将令许多工作繁重的程序设计师有时间多喝几杯咖啡。

  Doxygen就是这样的一个工具。在您写批注时,稍微按照一些它所制订的规则。接着,他就可以帮您产生出漂亮的文件了。因此,Doxygen的使用可分为两大部分。首先是特定格式的批注撰写,第二便是利用Doxygen的工具来产生文件。

 安装下载 自己在网上找找怎么搞,不过在我国的局域网上访问不了它的主页的,您可以委托国外的朋友帮您下载,然后给您传回来.

下来 我就给大家介绍一下这个东西倒底是怎么个使用法:

它的功能大概就是把代码上的注解 生成一个html 或者chm 或者pdf  文档

,哪还等什么赶紧把我的代码生成一个文档吧等等.. 其实它还没那么智能

常用指令介绍

@file

档案的批注说明。

@author

作者的信息

@brief

用于class 或function的简易说明

eg:

@brief 本函数负责打印错误信息串

@param

主要用于函数说明中,后面接参数的名字,然后再接关于该参数的说明

@return

描述该函数的返回值情况

eg:

@return 本函数返回执行结果,若成功则返回TRUE,否则返回FLASE

@retval

描述返回值类型

eg:

@retval NULL 空字符串。

@retval !NULL 非空字符串。

@note

注解

@attention

注意

@warning

警告信息

@enum

引用了某个枚举,Doxygen会在该枚举处产生一个链接

eg:

@enum CTest::MyEnum

@var

引用了某个变量,Doxygen会在该枚举处产生一个链接

eg:

@var CTest::m_FileKey

@class

引用某个类,

格式:@class <name> [<header-file>] [<header-name>]

eg:

@class CTest "inc/class.h"

@exception

可能产生的异常描述

eg:

@exception 本函数执行可能会产生超出范围的异常

@todo

对将要做的事情进行注释

@see

一段包含其他部分引用的注释,中间包含对其他代码项的名称,自动产生对其的引用链接。

@relates <name>

通常用做把非成员函数的注释文档包含在类的说明文档中。

@since

通常用来说明从什么版本、时间写此部分代码。

@code

在注释中开始说明一段代码,直到@endcode命令。

@endcode

注释中代码段的结束。

@pre

用来说明代码项的前提条件。

@post

用来说明代码项之后的使用条件。

 @deprecated

这个函数可能会在将来的版本中取消。

@defgroup

 模块名

@class

 声明一个类

@fn

 声明一个函数


TAG: file param Doxygen brief return

 

评分:0

我来说两句

显示全部

:loveliness: :handshake :victory: :funk: :time: :kiss: :call: :hug: :lol :'( :Q :L ;P :$ :P :o :@ :D :( :)

Open Toolbar