计算机源代码编写规范.doc

《计算机源代码编写规范.doc》由会员上传分享，免费在线阅读，更多相关内容在行业资料-天天文库。

1、计算机源代码编写规第一章概述规制定原则1方便代码的交流和维护。2不影响编码的效率，不与大众习惯冲突。3使代码更美观、阅读更方便。4使代码的逻辑更清晰、更易于理解。术语定义Pascal大小写将标识符的首字母和后面连接的每个单词的首字母都大写。可以对三字符或更多字符的标识符使用Pascal大小写。例如：BackColorCamel大小写标识符的首字母小写，而每个后面连接的单词的首字母都大写。例如：backColor文件命名组织1.3.1文件命名1文件名遵从Pascal命名法，无特殊情况，扩展名小写。2使用统一而又通用

2、的文件扩展名：C#类.cs1.3.2文件注释1在每个文件头必须包含以下注释说明/*----------------------------------------------------------------//Copyright(C)2011市鹏为软件//所有。////文件名：//文件功能描述：//////创建标识：////修改标识：//修改描述：////修改标识：//修改描述：//----------------------------------------------------------------

3、*/文件功能描述只需简述，具体详情在类的注释中描述。创建标识和修改标识由创建或修改人员的拼音或英文名加日期组成。如：轶20040408一天有多个修改的只需做一个在注释说明中做一个修改标识就够了。在所有的代码修改处加上修改标识的注释。第二章代码外观2.1列宽代码列宽控制在110字符左右。2.2换行当表达式超出或即将超出规定的列宽，遵循以下规则进行换行1、在逗号后换行。2、在操作符前换行。3、规则1优先于规则2。当以上规则会导致代码混乱的时候自己采取更灵活的换行规则。2.3缩进缩进应该是每行一个Tab(4个空格)，不

4、要在代码中使用Tab字符。VisualStudio.Net设置：工具->选项->文本编辑器->C#->制表符->插入空格2.4空行空行是为了将逻辑上相关联的代码分块，以便提高代码的可阅读性。在以下情况下使用两个空行1、接口和类的定义之间。2、枚举和类的定义之间。3、类与类的定义之间。在以下情况下使用一个空行1、方法与方法、属性与属性之间。2、方法中变量声明与语句之间。3、方法与方法之间。4、方法中不同的逻辑块之间。5、方法中的返回语句与其他的语句之间。6、属性与方法、属性与字段、方法与字段之间。7、注释与它注释的

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

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

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

8、限制很有帮助。注释样本应该是解释它为什么存在和可以做什么的简短介绍.3、避免在代码行的末尾添加注释；行尾注释使代码更难阅读。不过在批注变量声明时，行尾注释是合适的；在这种情况下，将所有行尾注释在公共制表位处对齐。4、避免杂乱的注释，如一整行星号。而是应该使用空白将注释同代码分开。5、避免在块注释的周围加上印刷框。这样看起来可能很漂亮，但是难于维护。6、在部署发布之前，移除