- 1、本文档共12页,可阅读全部内容。
- 2、原创力文档(book118)网站文档一经付费(服务费),不意味着购买了该文档的版权,仅供个人/单位学习、研究之用,不得用于商业用途,未经授权,严禁复制、发行、汇编、翻译或者网络传播等,侵权必究。
- 3、本站所有内容均由合作方或网友上传,本站不对文档的完整性、权威性及其观点立场正确性做任何保证或承诺!文档内容仅供研究参考,付费前请自行鉴别。如您付费,意味着您自己接受本站规则且自行承担风险,本站不退款、不进行额外附加服务;查看《如何避免下载的几个坑》。如果您已付费下载过本站文档,您可以点击 这里二次下载。
- 4、如文档侵犯商业秘密、侵犯著作权、侵犯人身权等,请点击“版权申诉”(推荐),也可以打举报电话:400-050-0827(电话支持时间:9:00-18:30)。
- 5、该文档为VIP文档,如果想要下载,成为VIP会员后,下载免费。
- 6、成为VIP后,下载本文档将扣除1次下载权益。下载后,不支持退款、换文档。如有疑问请联系我们。
- 7、成为VIP后,您将拥有八大权益,权益包括:VIP文档下载权益、阅读免打扰、文档格式转换、高级专利检索、专属身份标志、高级客服、多端互通、版权登记。
- 8、VIP文档为合作方或网友上传,每下载1次, 网站将根据用户上传文档的质量评分、类型等,对文档贡献者给予高额补贴、流量扶持。如果你也想贡献VIP文档。上传文档
查看更多
C++注释规范
前言
为了保持程序源码与文档的一致性,提出了源码注释规范化。
文档修订记录
日期 版本 作者 修改内容 2009-6-18 0.1 李建生 创建
适用范围
C++
引用文件
doxygen_manual-1.5.9.pdf
术语
概述
根据文档化的源码,直接从源码中抽取文档,保持文档源码一致性。采用开源工具Doxygen,支持输出html、pdf、chm、man手册等。Doxygen支持两种形式的注释:JavaDoc和QT风格,本规范采用通用的JavaDoc形式,更适合一般的编程习惯。
Doxygen安装
Windows平台
直接运行Doxygen 的 Setup EXE文件,依据提示进行安装操作;
运行Graphviz的安装(EXE)文件,依据提示进行安装操作。
Doxygen运行
DOXYFILE_ENCODING=GBK
OUTPUT_LANGUAGE=Chinese
INPUT_ENCODING=GBK
FILE_PATTERNS=*.h *.cpp
RECURSIVE=true
EXTRACT_ALL=TRUE
EXTRACT_PRIVATE=TRUE
EXTRACT_STATIC=TRUE
EXTRACT_LOCAL_CLASSES=TRUE
EXTRACT_LOCAL_METHODS=TRUE
SHOW_INCLUDE_FILES=TRUE
INLINE_INFO=TRUE
SHOW_DIRECTORIES=TRUE
SHOW_FILES=TRUE
SHOW_NAMESPACE=TRUE
Doxygen介绍
如果采用Doxygen为代码产生文档,在编写代码时首先要为代码添加Doxygen风格的注释,这些Doxygen风格的注释可以称为文档块(Document block),添加注释的这个动作可以称为文档化代码。Doxygen会根据相应的doxygen注释块为代码生成相应的文档。
对每个代码条目,Doxygen有两种(在某些情况下可以3种)类型的说明,共同组成文档:简要说明和详细说明。对应方法和函数可以有第三种风格的注释,函数体内注释(in body)。因为没有指定描述顺序,因此不建议多条简要说明或详细说明。
简要说明只有一行,详细说明可以有多行。
以下描述全部以JavaDoc为例。
详细注释
1、JavaDoc风格的注释,这种风格的注释是在C风格的注释块开始处有两个 “ * “,如下:
/**
* ... 注释块 ...
*/
上例中文本前的 “ * “ 是可选的,也可以写成
/**
... 注释块 ...
*/
3、单行注释也可以采用如下方式
///
/// ... 注释 ...
///
4、如下注释也是可以的
/********************************************//**
* ... 注释
***********************************************/
或者
/////////////////////////////////////////////////
/// ...注释...
/////////////////////////////////////////////////
简要注释
如果配置文件中把 JAVADOC_AUTOBRIEF 设置成 YES,则可以使用JavaDoc风格注释块, 这种风格的注释,简要说明自动从“*“后开始 ,直到第一个”.”号结束,例如:
/** 简要说明.
* 详细说明.
*/
多行C++风格注释:
/// 简要说明.
/// 详细说明.
3、可以采用如下注释:
/// 简要说明.
/** 详细说明. */
上例中间空行用来分隔简要说明和详细说明的。请注意下面格式的注释是不合法的,Doxygen只允许一条详细说明对应一条简要说明:
如果一个代码项的声明和定义之前都有简要说明,则Doxygen只使用声明之前的说明。
如果一个代码项在声明和定义之前都有详细说明, 则Doxygen使用定义之前的说明。
模块注释
定义模块(组)
/*
* @defgroup 模块名(具有唯一性) 模块的说明文字
* @{
*/
… 定义的内容 …
/** @} */ // 模块结尾
增加到组中
在文档块中增加:ingroup 模块名
示例
/** @defgroup common common lib
* This is the first group
* @{
* @}
*/
/** @defgroup base base lib
* @ingroup common
*/
成员分组
如果一个组合结构
您可能关注的文档
- 《基于白盒测试的软件测试技术开发》.doc
- 《学籍管理系统》--需求分析(流程图).doc
- 【英】众所周知原文.doc
- 01Java简介及helloworld初步.ppt
- 1-2第5章 网络层.ppt
- 1-C程序概述.ppt
- 02Java变量与数据类型.ppt
- 2JAVA语言基础.ppt
- 2程序流程控制.ppt
- 2网际控制消息协议(ICMP).ppt
- 2024年山东省聊城东阿县事业单位选聘32人历年高频考题难、易错点模拟试题(共500题)附带答案详解.docx
- 2024年山东省聊城莘县事业单位招聘单位高频考题难、易错点模拟试题(共500题)附带答案详解.docx
- 汽机专业题库及解析.docx
- 基本常规医疗流程答案.doc
- 大金空调故障代码汇总.docx
- 理综-山西省阳泉市2023-2024学年高三年级上学期期末考试试题和答案.docx
- 数学-海南省天一大联考2023-2024学年高三学业水平诊断(二)带答案.docx
- 地理-湖南省长沙市雅礼中学2023-2024学年高三上学期月考试卷带答案.docx
- 生物-湖南省长沙市雅礼中学2023-2024学年高三上学期月考试卷带答案.docx
- 数学-湖南省长沙市雅礼中学2023-2024学年高三上学期月考试卷带答案.docx
文档评论(0)