Net代码编写规范

郑州海为电子科技有限公司1目的为了统一公司软件开发的设计过程中关于代码编写时的编写规范和具体开发工作时的编程规范，保证代码的一致性，便于交流和维护，特制定此规范。2范围本规范适用于开发组全体人员，作用于软件项目开发的代码编写阶段和后期维护阶段。3注释规范3.1概述1)注释建议使用英文及英文的标点符号。2)注释中，应表明对象的完整的名称及其用途，但应避免对代码过于详细的描述。3)每行注释的最大长度为100个字符。4)不允许给注释加外框。5)编码的同时书写注释。6)重要变量必须有注释。7)变量注释和变量在同一行，所有注释必须对齐，与变量分开至少两个“Tab”键。8)典型算法必须有注释。9)在循环和逻辑分支地方的上行必须就近书写注释。10)程序段或语句的注释在程序段或语句的上一行。11)在代码交付之前，必须删掉临时的或无关的注释。12)为便于阅读代码，每行代码的长度应少于100个字符。3.2自建代码文件注释对于自己创建的代码文件（如函数、脚本），在文件开头，一般编写如下注释：/******************************************************FileName:Copyright(c)2004-xxxx*********公司技术开发部Writer:createDate:Rewriter:RewriteDate:Impact:MainContent（FunctionName、parameters、returns）******************************************************/3.3模块（类）注释模块开始建议使用以下形式书写模块注释：///summary郑州海为电子科技有限公司///ModuleID：模块编号，可以引用系统设计中的模块编号///Depiction：对此类的描述，可以引用系统设计中的描述///Author：作者中文名///CreateDate：模块创建日期，格式：YYYY-MM-DD////summary如果模块只进行部分少量代码的修改时，则每次修改须添加以下注释：///Rewriter：///RewriteDate：修改日期，格式：YYYY-MM-DDStart1：/*原代码内容*////End1：将原代码内容注释掉，然后添加新代码使用以下注释：///Addedby：///Adddate：添加日期，格式：YYYY-MM-DDStart2：新代码内容///End2：如果模块输入输出参数或功能结构有较大修改，则每次修改必须添加以下注释：///summary///LogID：Log编号,从1开始一次增加///depiction：对此修改的描述///Writer：修改者中文名///RewriteDate：模块修改日期，格式：YYYY-MM-DD////summary3.4类属性注释在类的属性必须以以下格式编写属性注释：///summary///Propertiesdepiction////summary3.5方法注释在类的方法声明前必须以以下格式编写注释///summary///depiction：对该方法的说明////summary///paramname=参数名称参数说明/param///returns///对方法返回值的说明，该说明必须明确说明返回的值代表什么含义////returns郑州海为电子科技有限公司///Writer：作者中文名///CreateDate：方法创建日期，格式：YYYY-MM-DD3.6代码间注释代码间注释分为单行注释和多行注释：单行注释：//单行注释多行注释：/*多行注释1多行注释2多行注释3*/代码中遇到语句块时必须添加注释（if,for,foreach,……）,添加的注释必须能够说明此语句块的作用和实现手段（所用算法等等）。4命名总体规则名字应该能够标识事物的特性。名字一律使用英文单词，而不能为拼音。名字尽量不使用缩写，除非它是众所周知的。名字可以有两个或三个单词组成，但不应多于三个，控制在3至30个字母以内。在名字中，多个单词用大写第一个字母（其它字母小写）来分隔。例如：IsSuperUser。名字尽量使用前缀而不是后缀。名字中的单词尽量使用名词，如有动词，也尽量放在后面。例如：FunctionUserDelete（而不是FunctionDeleteUser）。文件名一般以类名一致，切遵循类命定义规则，及大小写规范。在具体任务开发中，如果有特定的命名约定，则在相应的软件开发计划中予以明确定义及上报质量管理部审计组。5命名规范5.1变量（Variable）命名5.1.1程序文件(*.cs)中的变量命名Ø所有变量如果无前缀必须首字母小写，前缀无特殊要求，但必须是易于识别公认的做法，如’m_’‘_’,切毋自创缩写Ø过程级的变量不使用前缀例如：publicclasshello{voidsay()郑州海为电子科技有限公司{stringSayWord;}}Ø过程的参数使用“p_”作为参数例如：publicclasshello{voidsay(stringp_SayWord){}}补充说明：针对异常捕获过程中的Exception变量命名，在没有冲突的情况下，统一命名为e；如果有冲突的情况下，可以重复e，比如：ee。Try{//yourcodetry{//code}catch(Exceptionee){//yourcode}}catch(Exceptione){//yourcode}补充：如果捕获异常不需要作任何处理，则不需要定义Exception实例例：try{//yourcode}catch(Exception){}Ø鉴于大多数名称都是通过连接若干单词构造的，必须使用大小写混合的格式以简化它们的阅读。每个单词的第一个字母都是大写.Ø即使对于可能仅出现在几个代码行中的生存期很短的变量，仍然使用有意郑州海为电子科技有限公司义的名称。仅对于短循环索引使用单字母变量名，如i或j。Ø在变量名中使用互补对，如min/max、begin/end和open/close。Ø不要使用原义数字或原义字符串，如For(i=1;i=7;i++)。而是使用命名常数，如For(i=1;i=NUM_DAYS_IN_WEEK;i++)以便于维护和理解。5.1.2控件命名控件命名=Web控件缩写前缀+[“_”]+名称如：DataGriddg_UserList或dgUserlist5.2常量命名常量名也应当有一定的意义，格式为NOUN或NOUN_VERB。常量名均为大写，字之间用下划线分隔。例：privateconstboolWEB_ENABLEPAGECACHE_DEFAULT=true;privateconstintWEB_PAGECACHEEXPIRESINSECONDS_DEFAULT=3600;privateconstboolWEB_ENABLESSL_DEFAULT=false;注：变量名和常量名最多可以包含255个字符，但是，超过25到30个字符的名称比较笨拙。此外，要想取一个有实际意义的名称，清楚地表达变量或常量的用途，25或30个字符应当足够了。5.3类（Class）命名1)名字应该能够标识事物的特性。2)名字尽量不使用缩写，除非它是众所周知的。3)名字可以有两个或三个单词组成，但通常不应多于三个。4)在名字中，所有单词第一个字母大写。例如IsSuperUser，包含ID的，ID可以全部大写，如CustomerID。5)使用名词或名词短语命名类。6)少用缩写。7)不要使用下划线字符(_)。例：publicclassFileStreampublicclassButtonpublicclassString5.4接口（Interface）命名和类命名规范相同，唯一区别是接口在名字前加上“I”前缀例：interfaceIDBCommand;interfaceIButton;郑州海为电子科技有限公司5.5方法（Method）命名和类命名规范相同。5.6命名空间（NameSpace）命名和类命名规范相同。5.7属性(Property)命名与类名命名规范相同。6编码规则6.1错误检查规则a)编程中要考虑函数的各种执行情况，尽可能处理所有流程情况。b)检查所有的系统调用的错误信息，除非要忽略错误。c)将函数分两类：一类为与屏幕的显示无关，另一类与屏幕的显示有关。对于与屏幕显示无关的函数，函数通过返回值来报告错误。对于与屏幕显示有关的函数，函数要负责向用户发出警告，并进行错误处理。d)错误处理代码一般放在函数末尾。e)对于通用的错误处理，可建立通用的错误处理函数，处理常见的通用的错误。6.2大括号规则将大括号放置在关键词下方的同列处，列如：If($condition){///}while($condition){///}6.3缩进规则使用一个“Tab”为每层次缩进。例如：Functionfunc(){if(somethingbad){if(anotherthingbad){while(moreinput){}郑州海为电子科技有限公司}}}6.4小括号规则a)不要把小括号和关键词（if、while等）紧贴在一起，要用空格隔开它们。b)不要把小括号和函数名紧贴在一起。c)除非必要，不要在Return返回语句中使用小括号。因为关键字不是函数，如果小括号紧贴着函数名和关键字，二者很容易被看成是一体的。6.5IfThenElse规则如果你有用到elseif语句的话，通常最好有一个else块以用于处理未处理到的其他情况。可以的话放一个记录信息注释在else处，即使在else没有任何的动作。其格式为：if(条件1)//注释{}elseif(条件2)//注释{}else//注释{}注：if和循环的嵌套最多允许4层6.6比较规则总是将恒量放在等号/不等号的左边。一个原因是假如你在等式中漏了一个等号，语法检查器会为你报错。第二个原因是你能立刻找到数值而不是在你的表达式的末端找到它。例如：if(6==$errorNum)...6.7Case规则defaultcase总应该存在，如果不允许到达，则应该保证：若到达了就会触发一个错误。Case的选择条件最好使用int或string类型。6.8对齐规则变量的申明和初始化都应对齐。例如：intm_iCount;inti,j;floatm_fIncome,m_fPay;m_iCount=0;i=1;m_fIncome=0.3;郑州海为电子科技有限公司6.9代码语句规则1)所有的缩进为4个空格，使用VS.NET的默认设置。2)在代码中垂直对齐左括号和右括号。if(x==0){Response.Write(用户编号必须输入！);}不允许以下情况：if(x==0){Response.Write(用户编号必须输入！);}或者：if(x==0){Response.Write(用户编号必须输入！);}3)为了防止在阅读代码时不得不滚动源代码编辑器，每行代码或注释在1024*800的显示频率下不得超过一显示屏4)当一行被分为几行时，通过将串联运算符放在每一行的末尾而不是开头，清楚地表示没有后面的行是不完整的。5)每一行上放置的语句避免超过一条。6)在大多数运算符之前和之后使用空格，这样做时不会改变代码的意图却可以使代码容易阅读。例：intj=i+k;而不应写为intj=i+k;7)将大的复杂代码节分为较小的、易于理解的模块。6.10单一功能规则原则上，一个程序单元（函数、例程、方法）只完成一项功能。6.11简单功能规则原则上，一个程序单元的代码应该限制在一页内（25~30行）。6.12明确条件规则不要采用缺省值测试非零值。例如：使用“if(0!=f())”而不用“if(f())”。6.13选用FALSE规则大部分函数在错误时返回FALSE、0或NO之类的值，但在正确时返回值就不定了（不能用一个固定的TRUE、