公司编码规范

公司编码规范

ID:38346652

大小:141.50 KB

页数:17页

时间:2019-06-10

公司编码规范_第1页
公司编码规范_第2页
公司编码规范_第3页
公司编码规范_第4页
公司编码规范_第5页
资源描述:

《公司编码规范》由会员上传分享,免费在线阅读,更多相关内容在行业资料-天天文库

1、公司编码规范17目录第一部分概述31.1规范制定原则31.2术语定义31.2.1Pascal大小写31.2.2Camel大小写3第二部分程序版式32.1列宽32.2换行32.3空行32.4空格42.5括号-()42.6花括号-{}52.7注释62.7.1概述62.7.2注释的使用6第三部分命名规则73.1共用部分73.2C++部分83.3C#部分9第四部分语句规则144.1共用部分144.2C++部分144.2.1常量144.2.2if语句144.2.2.1布尔变量与零值比较144.2.2.2整型变量与零值比较154.2.2.3浮点变量与零值比较154.

2、2.2.4指针变量与零值比较154.2.2.5对if语句的补充说明154.2.3函数16第五部分匈牙利命名法1617概述1.1规范制定原则1方便代码的交流和维护。2不影响编码的效率,不与大众习惯冲突。3使代码更美观、阅读更方便。4使代码的逻辑更清晰、更易于理解。1.2术语定义1.2.1Pascal大小写将标识符的首字母和后面连接的每个单词的首字母都大写。可以对三字符或更多字符的标识符使用Pascal大小写。例如:BackColor1.2.2Camel大小写标识符的首字母小写,而每个后面连接的单词的首字母都大写。例如:backColor第二部分程序版式2.

3、1列宽代码列宽控制在110字符左右。2.2换行当表达式超出或即将超出规定的列宽,遵循以下规则进行换行:1、在逗号后换行。2、在操作符前换行。3、规则1优先于规则2。当以上规则会导致代码混乱的时候自己采取更灵活的换行规则。2.3空行空行是为了将逻辑上相关联的代码分块,以便提高代码的可阅读性。在以下情况下使用两个空行:1、接口和类的定义之间。2、枚举和类的定义之间。173、类与类的定义之间。在以下情况下使用一个空行:1、方法与方法、属性与属性之间。2、方法中变量声明与语句之间。3、方法与方法之间。4、方法中不同的逻辑块之间。 5、方法中的返回语句与其他的语句

4、之间。6、属性与方法、属性与字段、方法与字段之间。7、注释与它注释的语句间不空行,但与其他的语句间空一行。1.1空格在以下情况中要使用到空格:1、关键字和左括符“(”应该用空格隔开。如:while(true)注意在方法名和左括符“(”之间不要使用空格,这样有助于辨认代码中的方法调用与关键字。2、多个参数用逗号隔开,每个逗号后都应加一个空格。3、除了.之外,所有的二元操作符都应用空格与它们的操作数隔开。一元操作符、++及--与操作数间不需要空格。如A+=c+d;A=(a+b)/(c*d);while(d++=s++){n++;}PrintSize(“siz

5、eis“+size+“”);4、语句中的表达式之间用空格隔开。如for(expr1;expr2;expr3)1.2括号-()1、左括号“(”不要紧靠关键字,中间用一个空格隔开。2、左括号“(”与方法名之间不要添加任何空格。3、没有必要的话不要在返回语句中使用()。如:if(condition)17Array.Remove(1)return1;1.1花括号-{}1、左花括号“{”放于关键字或方法名的下一行并与之对齐。如:if(condition){}publicintAdd(intx,inty){}2、左花括号“{”要与相应的右花括号“}”对齐。3、通

6、常情况下左花括号“{”单独成行,不与任何语句并列一行。4、if、while、do语句后一定要使用{},即使{}号中为空或只有一条语句。如:if(somevalue==1){somevalue=2;}5、右花括号“}”后建议加一个注释以便于方便的找到与之相应的{。如:while(1){if(valid){}//ifvalidelse{}//notvalid}//endforever1.2注释1.2.1概述1、修改代码时,总是使代码周围的注释保持最新。171、在每个例程的开始,提供标准的注释样本以指示例程的用途、假设和限制很有帮助。注释样本应该是解释它为什么

7、存在和可以做什么的简短介绍.2、避免在代码行的末尾添加注释;行尾注释使代码更难阅读。不过在批注变量声明时,行尾注释是合适的;在这种情况下,将所有行尾注释在公共制表位处对齐。3、在部署发布之前,移除所有临时或无关的注释,以避免在日后的维护工作中产生混乱。4、如果需要用注释来解释复杂的代码节,请检查此代码以确定是否应该重写它。尽一切可能不注释难以理解的代码,而应该重写它。尽管一般不应该为了使代码更简单以便于人们使用而牺牲性能,但必须保持性能和可维护性之间的平衡。5、在编写注释时使用完整的句子。注释应该阐明代码,而不应该增加多义性。6、在编写代码时就注释,因为

8、以后很可能没有时间这样做。另外,如果有机会复查已编写的代码,在今天看来很明显的东

当前文档最多预览五页,下载文档查看全文

此文档下载收益归作者所有

当前文档最多预览五页,下载文档查看全文
温馨提示:
1. 部分包含数学公式或PPT动画的文件,查看预览时可能会显示错乱或异常,文件下载后无此问题,请放心下载。
2. 本文档由用户上传,版权归属用户,天天文库负责整理代发布。如果您对本文档版权有争议请及时联系客服。
3. 下载前请仔细阅读文档内容,确认文档内容符合您的需求后进行下载,若出现内容与标题不符可向本站投诉处理。
4. 下载文档时可能由于网络波动等原因无法下载或下载错误,付费完成后未能成功下载的用户请联系客服处理。