运算符优先级列表编程命名规则

上传人:bin****86 文档编号:49704368 上传时间:2018-08-01 格式:DOC 页数:8 大小:125.01KB
返回 下载 相关 举报
运算符优先级列表编程命名规则_第1页
第1页 / 共8页
运算符优先级列表编程命名规则_第2页
第2页 / 共8页
运算符优先级列表编程命名规则_第3页
第3页 / 共8页
运算符优先级列表编程命名规则_第4页
第4页 / 共8页
运算符优先级列表编程命名规则_第5页
第5页 / 共8页
点击查看更多>>
资源描述

《运算符优先级列表编程命名规则》由会员分享,可在线阅读,更多相关《运算符优先级列表编程命名规则(8页珍藏版)》请在金锄头文库上搜索。

1、优先级运算符名称或含义使用形式结合方向 说明数组下标数组名常量表达式()圆括号(表达式)/函数名 (形参表).成员选择(对象)对象.成员名1-成员选择(指针)对象指针-成员名左到右-负号运算符-表达式单目运算符 (类型)强制类型转换(数据类型)表达式+自增运算符+变量名/变量名+单目运算符-自减运算符-变量名/变量名-单目运算符*取值运算符*指针变量单目运算符即:变量名 =m_+变量类型+变量的英文意思(或缩写) .对枚举类型(enum)中的变量,要求用枚举变量或其缩写做前缀。并且 要求用大写。 如:enum cmEMDAYS/枚举类型名; EMDAYS_MONDAY; EMDAYS_TUES

2、DAY; ; .对 struct.union.class 变量的命名要求定义的类型用大写。并要加上 前缀,其内部变量的命名规则与变量命名规则一致。 结构一般用 S 开头 如:struct ScmNPoint int nX;/点的 X 位置 int nY; /点的 Y 位置 ; 联合体一般用 U 开头 如: union UcmLPoint long lX; long lY; 类一般用 C 开头 如: class CcmFPoint /类型用大写 public: float fPoint; ; 对一般的结构应该定义为类模板,为以后的扩展性考虑 如: template class CcmTVecto

3、r3d public: TYPE x,y,z; ; .对常量(包括错误的编码)命名,要求常量名用大写,常量名用英文表 达其意思。 如:#define CM_FILE_NOT_FOUND CMMAKEHR(0X20B) 其中 CM 表示类别。.对 const 的变量要求在变量的命名规则前加入 c_,即:c_+变量命名规 则;例如: const char* c_szFileName; 2.函数的命名规范:函数的命名规范: 函数的命名应该尽量用英文表达出函数完成的功能。遵循动宾结构的命名 法则,函数名中动词在前,并在命名前加入函数的前缀,函数名的长度不得少于 8 个字母。 例如: long cmGe

4、tDeviceCount(); 3.函数参数规范: .参数名称的命名参照变量命名规范。 .为了提高程序的运行效率,减少参数占用的堆栈,传递大结构的参数, 一律采用指针或引用方式传递。 .为了便于其他程序员识别某个指针参数是入口参数还是出口参数,同时 便于编译器检查错误,应该在入口参数前加入 const 标志。如: cmCopyString(const char *c_szSource, char *szDest) 4.引出函数规范: 对于从动态库引出作为二次开发函数公开的函数,为了能与其他函数以及 Windows 的函数区分,采用类别前缀+基本命名规则的方法命名。例如:在对动 态库中引出的一个

5、图象编辑的函数定义为 imgFunctionname(其中 img 为 image 缩写)。 现给出三种库的命名前缀: .对通用函数库,采用 cm 为前缀。 .对三维函数库,采用 vr 为前缀。 .对图象函数库,采用 img 为前缀。 对宏定义,结果代码用同样的前缀。 5.文件名(包括动态库.组件.控件.工程文件等)的命名规范: 文件名的命名要求表达出文件的内容,要求文件名的长度不得少于 5 个字 母,严禁使用象 file1,myfile 之类的文件名。 三.注释规范: 1.函数头的注释 对于函数,应该从“功能” , “参数” , “返回值”.“主要思路”.“调用方 法”.“日期”六个方面用如

6、下格式注释: /程序说明开始 /=/ 功能: 从一个 String 中删除另一个 String。 / 参数: strByDelete,strToDelete / (入口) strByDelete: 被删除的字符串(原来的字符串) / (出口) strToDelete: 要从上个字符串中删除的字符串。 / 返回: 找到并删除返回 1,否则返回 0。 (对返回值有错误编码的要求列 出错误编码) 。/ 主要思路:本算法主要采用循环比较的方法来从 strByDelete 中找到 / 与 strToDelete 相匹配的字符串,对多匹配 strByDelete / 中有多个 strToDelete 子串

7、)的情况没有处理。请参阅: / 书名 / 调用方法: / 日期:起始日期,如:2000/8/21.9:40-2000/8/23.21:45 /=/函数名() /程序说明结束 .对于某些函数,其部分参数为传入值,而部分参数为传出值,所以对参 数要详细说明该参数是入口参数,还是出口参数,对于某些意义不明确的参数 还要做详细说明(例如:以角度作为参数时,要说明该角度参数是以弧度 (PI),还是以度为单位),对既是入口又是出口的变量应该在入口和出口处同 时标明。等等。 .函数的注释应该放置在函数的头文件中,在实现文件中的该函数的实现 部分应该同时放置该注释。 .在注释中应该详细说明函数的主要实现思路.

8、特别要注明自己的一些想 法,如果有必要则应该写明对想法产生的来由。对一些模仿的函数应该注释上 函数的出处。 .在注释中详细注明函数的适当调用方法,对于返回值的处理方法等。在 注释中要强调调用时的危险方面,可能出错的地方。 .对日期的注释要求记录从开始写函数到结束函数的测试之间的日期。.对函数注释开始到函数命名之间应该有一组用来标识的特殊字符串。如果算法比较复杂,或算法中的变量定义与位置有关,则要求对变量的定 义进行图解。对难以理解的算法能图解尽量图解。 2.变量的注释: 对于变量的注释紧跟在变量的后面说明变量的作用。原则上对于每个变量 应该注释,但对于意义非常明显的变量,如:i,j 等循环变量

9、可以不注释。例如: long lLineCount /线的根数。 3.文件的注释: 文件应该在文件开头加入以下注释: / 工程: 文件所在的项目名。 / 作者:*,修改者:* / 描述:说明文件的功能。 / 主要函数: / 版本: 说明文件的版本,完成日期。 / 修改: 说明对文件的修改内容.修改原因以及修改日期。 / 参考文献: /为了头文件被重复包含要求对头文件进行定义如下: #ifndef _FILENAME_H_ #define _FILENAME_H_ 其中 FILENAME 为头文件的名字。 4.其他注释: 在函数内我们不需要注释每一行语句。但必须在各功能模块的每一主要部 分之前添

10、加块注释,注释每一组语句,在循环.流程的各分支等,尽可能多加以 注释。 其中的循环.条件.选择等位置必须注释。 对于前后顺序不能颠倒的情况,建议在注释中增加序号。 例如: 在其他顺序执行的程序中,每隔 35 行语句,必须加一个注释,注明这一 段语句所组成的小模块的作用。对于自己的一些比较独特的思想要求在注释中 标明。 四.程序健壮性: 1.函数的返回值规范: 对于函数的返回位置,尽量保持单一性,即一个函数尽量做到只有一个返 回位置。(单入口单出口)。 要求大家统一函数的返回值,所有的函数的返回值都将以编码的方式返回。例如编码定义如下: #define CM_POINT_IS_NULL CMMA

11、KEHR(0X200) : : 建议函数实现如下: long 函数名(参数,) long lResult; /保持错误号 lResult=CM_OK; /如果参数有错误则返回错误号 if(参数=NULL) lResult=CM_POINT_IS_NULL; goto END; END: return lResult; 2.关于 goto 的应用: 对 goto 语句的应用,我们要求尽量少用 goto 语句。对一定要用的地方要 求只能向后转移。 3.资源变量的处理(资源变量是指消耗系统资源的变量): 对资源变量一定赋初值。分配的资源在用完后必须马上释放,并重新赋值。4.对复杂的条件判断,为了程序的可读性,应该尽量使用括号。 例:if(szFileName!=NULL)&(lCount=0)|(bIsRead=TRUE) 五.可移植性: 1.高质量的代码要求能够跨平台,所以我们的代码应该考虑到对不同的平 台的支持,特别是对 windows 98 和 windows nt 的支持。 2.由于 C 语言的移植性比较好,所以对算法函数要求用 C 代码,不能用 C+代码。 3.对不同的硬件与软件的函数要做不同的处理

展开阅读全文
相关资源
相关搜索

当前位置:首页 > 大杂烩/其它

电脑版 |金锄头文库版权所有
经营许可证:蜀ICP备13022795号 | 川公网安备 51140202000112号