1 / 17
文档名称:

公司编码规范.doc

格式:doc   大小:141KB   页数:17页
下载后只包含 1 个 DOC 格式的文档,没有任何的图纸或源代码,查看文件列表

如果您已付费下载过本站文档,您可以点这里二次下载

分享

预览

公司编码规范.doc

上传人:lily8501 2020/5/27 文件大小:141 KB

下载得到文件列表

公司编码规范.doc

相关文档

文档介绍

文档介绍:公司编码规范目录第一部分 概述 规范制定原则 术语定义 Pascal大小写 Camel大小写 3第二部分 程序版式 列宽 换行 空行 空格 括号-() 花括号-{} 注释 概述 注释的使用 6第三部分 命名规则 共用部分 C++部分 C#部分 9第四部分 语句规则 共用部分 C++部分 常量 if语句 布尔变量与零值比较 整型变量与零值比较 浮点变量与零值比较 指针变量与零值比较 对if语句的补充说明 函数 16第五部分 匈牙利命名法 16概述规范制定原则1方便代码的交流和维护。2不影响编码的效率,不与大众习惯冲突。3使代码更美观、阅读更方便。4使代码的逻辑更清晰、更易于理解。术语定义Pascal大小写将标识符的首字母和后面连接的每个单词的首字母都大写。可以对三字符或更多字符的标识符使用Pascal大小写。例如:BackColorCamel大小写标识符的首字母小写,而每个后面连接的单词的首字母都大写。例如:backColor程序版式列宽代码列宽控制在110字符左右。换行当表达式超出或即将超出规定的列宽,遵循以下规则进行换行:1、在逗号后换行。2、在操作符前换行。3、规则1优先于规则2。当以上规则会导致代码混乱的时候自己采取更灵活的换行规则。空行空行是为了将逻辑上相关联的代码分块,以便提高代码的可阅读性。在以下情况下使用两个空行:1、接口和类的定义之间。2、枚举和类的定义之间。3、类与类的定义之间。在以下情况下使用一个空行:1、方法与方法、属性与属性之间。2、方法中变量声明与语句之间。3、方法与方法之间。4、方法中不同的逻辑块之间。 5、方法中的返回语句与其他的语句之间。6、属性与方法、属性与字段、方法与字段之间。7、注释与它注释的语句间不空行,但与其他的语句间空一行。空格在以下情况中要使用到空格:关键字和左括符“(”应该用空格隔开。如:while(true)注意在方法名和左括符“(”之间不要使用空格,这样有助于辨认代码中的方法调用与关键字。多个参数用逗号隔开,每个逗号后都应加一个空格。,所有的二元操作符都应用空格与它们的操作数隔开。一元操作符、++及--与操作数间不需要空格。如A+=c+d;A=(a+b)/(c*d);while(d++=s++){n++;}PrintSize(“sizeis“+size+“\n”);语句中的表达式之间用空格隔开。如for(expr1;expr2;expr3)括号-()左括号“(”不要紧靠关键字,中间用一个空格隔开。左括号“(”与方法名之间不要添加任何空格。没有必要的话不要在返回语句中使用()。如:if(condition)(1)return1;花括号-{}左花括号“{”放于关键字或方法名的下一行并与之对齐。如:if(condition){}publicintAdd(intx,inty){}左花括号“{”要与相应的右花括号“}”对齐。通常情况下左花括号“{”单独成行,不与任何语句并列一行。if、while、do语句后一定要使用{},即使{}号中为空或只有一条语句。如:if(somevalue==1){somevalue=2;}右花括号“}”后建议加一个注释以便于方便的找到与之相应的{。如:while(1){if(valid){}//ifvalidelse{}//notvalid}//endforever注释概述修改代码时,总是使代码周围的注释保持最新。在每个例程的开始,提供标准的注释样本以指示例程的用途、假设和限制很有帮助。;行尾注释使代码更难阅读。不过在批注变量声明时,行尾注释是合适的;在这种情况下,将所有行尾注释在公共制表位处对齐。在部署发布之前,移除所有临时或无关的注释,以避免在日后的维护工作中产生混乱。如果需要用注释来解释复杂的代码节,请检查此代码以确定是否应该重写它。尽一切可能不注释难以理解的代码,而应该重写它。尽管一般不应该为了使代码更简单以便于人们使用而牺牲性能,但必须保持性能和可维护性之间的平衡。在编写注释时使用完整的句子。注释应该阐明代码,而不应该增加多义性。在编写代码时就注释,因为以后很可能没有时间这样做。另外,如果有机会复查已编写的代码,在今天看来很明显的东西六周以后或许就不明显了。避免多余的或不适当的注释,如幽默的不主