没有合适的资源?快使用搜索试试~ 我知道了~
资源推荐
资源详情
资源评论
C++
编程命名规范
在软件开发过程中,代码的命名规范是一项很突出的内容。一套定义完整、结构清晰
明了的命名规范将大大提升源代码的可读性和软件的可维护性。
当然没有一种命名规则可以让所有的程序员都满意,程序设计教科书一般也不会指定
命名规则。但是制定一套统一的命名规则,并在项目中贯彻实施,是团队开发的产品质量
一项必不可少的工作。
第一部分:文件结构
文件头注释
所有 的源文件均必须包含一个规范的文件头,文件头包含了该文件的名称、功
能概述、作者、版权和版本历史信息等内容。标准文件头的格式为:
/*! @file
********************************************************************************
<PRE>
模块名€€€€€€ : <文件所属的模块名称>
文件名€€€€€€ : <文件名>
相关文件€€€€ : <与此文件相关的其它文件>
文件实现功能 : <描述该文件实现的主要功能>
作者€€€€€€€€ : <作者部门和姓名>
版本€€€€€€€€ : <当前版本号>
--------------------------------------------------------------------------------
多线程安全性 : <是/否>[,说明]
异常时安全性 : <是/否>[,说明]
--------------------------------------------------------------------------------
备注€€€€€€€€ : <其它说明>
--------------------------------------------------------------------------------
修改记录 :
日 期€€€€€€€ 版本€€€€ 修改人€€€€€€€€€€€€€ 修改内容
YYYY/MM/DD X.Y <作者或修改者名> <修改内容>
</PRE>
*******************************************************************************/
头文件
头文件通常由以下几部分组成:€
文件头注释 每个头文件,无论是内部的还是外部的,都应该由一个规
范的文件头注释作为开始。
预处理块 为 了 防 止 头 文 件 被 重 复 引 用 , 应 当 用
结构产生预处理块。€
函数和类/结构的声明等 声明模块的接口€
需要包含的内联函数定
义文件(如果有的话)
如果类中的内联函数较多,或者一个头文件中包含多个类
的定义(不推荐),可以将所有内联函数定义放入一个单
独的内联函数定义文件中,并在类声明之后用“
指令把它包含进来。
头文件的编码规则:
引用文件的格式 用 #include <filename.h> 格式来引用标准库和系统库的头
文件(编译器将从标准库目录开始搜索)。
用 #include "filename.h" 格式来引用当前工程中的头文件
(编译器将从该文件所在目录开始搜索)。
分割多组接口(如果有
的话)
如果在一个头件中定义了多个类或者多组接口(不推
荐),为了便于浏览,应该在每个类/每组接口间使用分割
带把它们相互分开。
内联文件
如上所述,在内联函数较多的情况下,为了避免头文件过长、版面混乱,可以将所有
的内联函数定义移到一个单独的文件中去,然后再用 指令将它包含到类声明的
后面。这样的文件称为一个内联函数定义文件。€
按照惯例,应该将这个文件命名为“,其中“与相应的头文件
和实现文件相同。
内联函数定义文件由以下几部分组成:
文件头注释 每内联函数定义文件都应该由一个规范的文件头注释作为
开始
内联函数定义 内联函数的实现体
内联函数定义文件的编码规则:
分割多组接口(如果有
的话)
如果在一个内联函数定义文件中定义了多个类或者多组接
口的内联函数(不推荐),必须在每个类/每组接口间使用
分割带把它们相互分开。
文件组成中为什么没有
预处理块?
与头文件不同,内联函数定义文件通常不需要定义预处理
块,这是因为他们总是被包含在与其相应的头文件预处理
块内。
实现文件
实现文件包含所有数据和代码的实现体。实现文件的格式为:€
文件头注释 每个实现文件都应该由一个规范的文件头注释作为开始
对配套头文件的引用 引用声明了此文件实现的类、函数及数据的头文件
对一些仅用于实现的头
文件的引用(如果有的
话)
将仅与实现相关的接口包含在实现文件里(而不是头文件
中)是一个非常好的编程习惯。这样可以有效地屏蔽不应
该暴露的实现细节,将实现改变对其它模块的影响降低到
最少 。
程序的实现体 数据和函数的定义
实现文件的编码规则:
分割每个部分 在本地(静态)定义和外部定义间,以及不同接口或不同
类的实现之间,应使用分割带相互分开。
第二部分:命名规则
【规则 】标识符应简单明了,望文知意。
剩余10页未读,继续阅读
资源评论
- liangbohuang2012-08-23免费的。。。
机器视觉大师
- 粉丝: 78
- 资源: 20
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功