- 1、本文档共48页,可阅读全部内容。
- 2、原创力文档(book118)网站文档一经付费(服务费),不意味着购买了该文档的版权,仅供个人/单位学习、研究之用,不得用于商业用途,未经授权,严禁复制、发行、汇编、翻译或者网络传播等,侵权必究。
- 3、本站所有内容均由合作方或网友上传,本站不对文档的完整性、权威性及其观点立场正确性做任何保证或承诺!文档内容仅供研究参考,付费前请自行鉴别。如您付费,意味着您自己接受本站规则且自行承担风险,本站不退款、不进行额外附加服务;查看《如何避免下载的几个坑》。如果您已付费下载过本站文档,您可以点击 这里二次下载。
- 4、如文档侵犯商业秘密、侵犯著作权、侵犯人身权等,请点击“版权申诉”(推荐),也可以打举报电话:400-050-0827(电话支持时间:9:00-18:30)。
查看更多
深圳市赛迅科技研发部C/C++代码规范
深圳市赛迅科技有限公司 PAGE 3 /
深圳市赛迅科技研发部C/C++代码规范
深圳市赛迅科技有限公司 PAGE 1 /
赛迅科技
C/C++ 代码规范
二零一零年十二月十七日
目录
TOC \o 1-3 \h \z \u 文件结构 3
文件头注释 3
头文件 4
内联函数定义文件 5
实现文件 5
文件的组织结构 6
命名规则 8
类/结构 8
函数 10
变量 11
常量 13
枚举、联合、typedef 13
宏、枚举值 13
名空间 14
代码风格与版式 15
类/结构 19
函数 23
变量、常量 30
枚举、联合、typedef 32
宏 33
名空间 35
异常 35
修改标记 46
文件结构
文件头注释
所有C++的源文件均必须包含一个规范的文件头,文件头包含了该文件的名称、功能概述、作者、版权和版本历史信息等内容。标准文件头的格式为:
/*! @file********************************************************************************PRE模块名?????? : 文件所属的模块名称文件名?????? : 文件名相关文件???? : 与此文件相关的其它文件文件实现功能 : 描述该文件实现的主要功能 作者???????? : 作者部门和姓名版本???????? : 当前版本号多线程安全性 : 是/否[,说明]异常时安全性 : 是/否[,说明]备注???????? : 其它说明修改记录 : 日 期??????? 版本???? 修改人????????????? 修改内容YYYY/MM/DD?? X.Y????? 作者或修改者名??? 修改内容/PRE*******************************************************************************/
如果该文件有其它需要说明的地方,还可以专门为此扩展一节 ,节与节之间用长度为80的“=”带分割:
/*! @file********************************************************************************PRE模块名?????? : 文件所属的模块名称文件名?????? : 文件名相关文件???? : 与此文件相关的其它文件文件实现功能 : 描述该文件实现的主要功能 作者???????? : 作者部门和姓名版本???????? : 当前版本号多线程安全性 : 是/否[,说明]异常时安全性 : 是/否[,说明]备注???????? : 其它说明修改记录 : 日 期??????? 版本???? 修改人????????????? 修改内容YYYY/MM/DD?? X.Y????? 作者或修改者名??? 修改内容/PRE********************************************************************************* 项目1? - 项目1.1? - 项目1.2================================================================================* 项目2? - 项目2.1? - 项目2.2*******************************************************************************/
每行注释的长度都不应该超过80个半角字符。还要注意缩进和对齐,以利阅读。
注意:将多线程和异常时安全性描述放在文件头,而不是类或者函数注释中,是为了体现以下设计思想:同一个模块中的界面,其各方面的操作方式和使用风格应该尽量保持一致。
头文件
头文件通常由以下几部分组成:
文件头注释
每个头文件,无论是内部的还是外部的,都应该由一个 规范的文件头注释作为开始。
预处理块
为了防止头文件被重复引用,应当用ifndef/define/endif结构产生预处理块。
函数和类/结构的声明等
声明模块的接口
需要包含的内联函数定义文件(如果有的话)
如果类中的内联函数较多,或者一个头文件中包含多个类的定义(不推荐),可以将所有内联函数定义放入一个单独的 内联函数定义文件中,并在类声明之后用“#in
您可能关注的文档
最近下载
- 最新最完整的的厂房设施确认实施方案.pdf
- 工程造价专业大学生职业生涯规划书.docx VIP
- 档案管理10号令解读(网).ppt
- 重庆《轻质隔墙条板应用技术标准》DBJ50T 338-2019.pdf
- (冀人版)科学五年级上册全册知识点.docx
- 电子工业版信息科技七年级上册3-1 “互联网+”在学习中的应用 教案.pdf VIP
- 2024-2025学年高中生物 第4章 种群和群落 第4节 群落的演替说课稿 新人教版必修3.docx
- 10 数学史问题与一元一次方程(含答案析) -七年级数学之专攻一元一次方程各种类型题的解法(人教版).docx
- 锅炉本体焊接作业指导书.pdf
- 钣金加工:折弯工艺手册.doc VIP
文档评论(0)