文档下载 文档下载导航
设为首页 | 加入收藏
搜索 请输入内容:  
 导航当前位置: 文档下载 > 所有分类 > 工程科技 > 信息与通信 > doxygen标准VC注释(转)
侵权投诉

doxygen标准VC注释(转)

编程代码注解工具doxygen

C++ 程序文档生成器介绍(doxygen) 程序文档,曾经是程序员的一个头痛问题。写一个程序文档,比较花时间,但不是很难;麻烦的是当程序修改后,程序文档也要跟着同步更新,否则文档和程序就要脱节,文档也就变成没用的东西了。

好在有许多好用的文档生成器来解决这个问题。目前比较流行的C++文档生成器是doxygen。 本文就简单的介绍一下doxygen的文档注释方法,以供初学者参考:

1. 模块定义(单独显示一页)

/*

* @defgroup 模块名 模块的说明文字

* @{

*/

... 定义的内容 ...

/** @} */ // 模块结尾

2. 分组定义(在一页内分组显示)

/*

* @name 分组说明文字

* @{

*/

... 定义的内容 ...

/** @} */

3. 变量、宏定义、类型定义简要说明

/** 简要说明文字 */

#define FLOAT float

/** @brief 简要说明文字(在前面加 @brief 是标准格式)#define MIN_UINT 0 */

第1页

你可能喜欢

  • 基准标注
  • 基准点
  • 能源基准
  • 评价基准
  • 定位基准
  • 尺寸基准

热门文档

相关文档

  • 基于doxygen的C++注释规范笔记

    基于doxygen的C++注释规范笔记_IT/计算机_专业资料。基于 doxygen 的文档注释... doxygen标准VC注释(转) 31页 免费 doxygen标准VC注释配置步... 31页 免费 ...

  • doxygen文档注释简介

    doxygen为C/C++程序自动生成文档之文档化代码(doxygen风格注释简介) 转载请注明:... doxygen配置说明 10页 免费 doxygen标准VC注释_完整... 31页 免费...

  • Doxygen注释使用中应该注意的问题

    Doxygen注释使用中应该注意的问题_法律资料_人文社科_专业资料。1. 2. 3. 4... doxygen标准VC注释配置步... 31页 免费 doxygen使用详解 4页 1下载券 ...

  • Doxygen配置(翻译)-ASP教程,ASP应用

    doxygen标准VC注释_完整... 31页 免费Doxygen配置(翻译)-ASP教程,A...

  • C++代码注释格式

    C++代码注释格式_for_doxygen_计算机软件及应用_IT/计算机_专业资料。对于使用... 什么是Doxygen 10页 免费 doxygen标准VC注释_完整... 31页 免费...

  • 注释规范

    文档注释可以通过 doxygen 工具转换 成 HTML 文件。 实现注释用以注释代码或者实现细节。文档注释从实现自由 (implementation-free)的角度描述代码的规范。它可以被那些...

  • doxygen 解析支持的标签规范

    doxygen 解析支持的标签规范 目录 1. 1. 2. 3. 4. 5. 6. 2. 3. dox... doxygen标准VC注释_完整... 31页 免费 基于doxygen的C++注释规... 2页 ...

  • doxygen讲解

    配置Doxygen Doxygen注释风格 使用Doxygen的目的生成模块文档,方便以后维护模块代码... Doxygen 源代码文档自动... 6页 免费 doxygen标准VC注释_完整... 31页 ...

  • C++注释规范

    11 1 说明本文档用于规范 C++代码中注释的编写。 规范中提出的多数注释格式都... C++注释规范 12页 免费 doxygen标准VC注释_完整... 31页 免费...

站点地图 | 文档上传 | 侵权投诉 | 手机版
本站所有资源均来自互联网,本站只负责收集和整理,均不承担任何法律责任,如有侵权等其它行为请联系我们.
文档下载 Copyright 2013 doc.guandang.net All Rights Reserved.  -  email