Chinaunix首页 | 论坛 | 博客
  • 博客访问: 2084699
  • 博文数量: 414
  • 博客积分: 10312
  • 博客等级: 上将
  • 技术积分: 4921
  • 用 户 组: 普通用户
  • 注册时间: 2007-10-31 01:49
文章分类

全部博文(414)

文章存档

2011年(1)

2010年(29)

2009年(82)

2008年(301)

2007年(1)

分类: 系统运维

2008-07-22 13:23:37

Doxygen 是一个类似 JavaDoc 的文档生成工具。有了它,C++爱好者就可以为自己的源代码很方便地生成美观实用的文档了。

为代码生成文档标注基础

  您可以使用JavaDoc风格,类似于由C风格的注释块:
/**
* ... 文本 ...
*/

此外您也可以使用Qt风格,如

/*!
* ... 文本...
*/

以上两种风格中间的*是可选的,也就是下面这样写也是可以的:

/*!
... 文本...
*/

第三种是使用至少两行C++"//"注释,如:

///
/// ... 文本...
///

或者

//!
//!...文本...
//!

有的程序员也许喜欢下面这种风格,有比较好的视觉效果:

/////////////////////////////////////////////////
/// ... 文本...
/////////////////////////////////////////////////

  对于简单的描述信息,可能有几种情况。一种是在注释块的开头使用\brief命令,该命令一直到段落结束有效,所以详细描述信息从空一行后开始,如下例:

/*! \brief 简洁的描述信息 description.
* 又一些简
阅读(1302) | 评论(0) | 转发(0) |
给主人留下些什么吧!~~