程序员开发手册

《安全生产信息化管理系统》程序员开发手册——————————————————————————————————————————————1《安全生产信息化管理系统》程序员开发手册1概述1.1目的1、方便代码的交流和维护。2、不影响编码的效率，不与大众习惯冲突。3、使代码更美观、阅读更方便。4、使代码的逻辑更清晰、更易于理解。1.2范围本手册适用于开发部全体人员，作用于软件项目开发的代码编写阶段和后期维护阶段。1.3警示通过自动检查【Microsoft.StyleCop】或人工检查【部门主管或相关负责人】不符合编码规范的，必须在限期【部门主管或相关负责人指定时间】内修正,逾期视为工作过失，部门主管或相关负责人视具体情况做出相关处理。1.4术语定义1、匈牙利命名法【禁用】标识符的名字以一个或者多个小写字母开头作为前缀；前缀之后的是首字母大写的一个单词或多个单词组合，该单词要指明变量的用途。例如：aUserId数组(Array)定义以小写字母a开头2、帕斯卡（pascal）命名法【推荐】将标识符的首字母和后面连接的每个单词的首字母都大写。可以对三字符或更多字符的标识符使用Pascal大小写。例如：UserId3、骆驼(Camel)命名法【推荐】标识符的首字母小写，而每个后面连接的单词的首字母都大写。例如：userId《安全生产信息化管理系统》程序员开发手册——————————————————————————————————————————————22代码格式2.1列宽1、为了防止在阅读代码时不得不滚动源代码编辑器，每行代码或注释在一般显示频率下不得超过一显示屏，代码列宽控制在110字符左右。2、系统中部分代码可以不遵循此原则。如：VIWFormItemDetail[]dv=(VIWFormItemDetail[])MHelper.SQLCommand.query(sql,VIWFormItemDetail.TName,sqlParams);3、SQL语句拼接、字符串拼接、函数参数名过长、判断语句过长的代码要遵循以上原则。2.2换行1、当表达式超出或即将超出规定的列宽，一行被分为几行时，通过将串联运算符放在每一行的末尾而不是开头，清楚地表示没有后面的行是不完整的。StringquerySql=“SELECTProjectId”+“,ProjectTitle”+“FROMProject”2、每一行上放置的语句避免超过一条。3、当表达式超出或即将超出规定的列宽，遵循以下规则进行换行(1)在逗号前换行。（2）在操作符前换行。（3）规则1优先于规则2。例如：StringBuilderquerySql=newStringBuilder();querySql.Append(SELECTa.ProjectIdASPK);querySql.Append(,a.ProjectTitle);querySql.Append(,a.ProjectDisplayCode);querySql.Append(,a.IsbnCodeASISBNCode);querySql.Append(FROMProjecta);当以上规则会导致代码混乱的时候自己采取更灵活的换行规则。《安全生产信息化管理系统》程序员开发手册——————————————————————————————————————————————32.3缩进缩进应该是每行一个Tab(4个空格)，不要在代码中使用Tab字符。VisualStudio.Net设置：工具-选项-文本编辑器-C#-制表符-插入空格2.4空行空行是为了将逻辑上相关联的代码分块，以便提高代码的可阅读性。在以下情况下使用两个空行1、接口和类的定义之间。2、枚举和类的定义之间。3、类与类的定义之间。在以下情况下使用一个空行1、方法与方法、属性与属性之间。2、方法中变量声明与语句之间。3、方法与方法之间。4、方法中不同的逻辑块之间。5、方法中的返回语句与其他的语句之间。6、属性与方法、属性与字段、方法与字段之间。7、注释与它注释的语句间不空行，但与其他的语句间空一行。2.5空格在以下情况中要使用到空格1、关键字和左括符“(”应该用空格隔开。如while(true)注意;在方法名和左括符“(”之间不要使用空格，这样有助于辨认代码中的方法调用与关键字。多个参数用逗号隔开，每个逗号后都应加一个空格。2、除了.之外，所有的二元操作符都应用空格与它们的操作数隔开。一元操作符、++及--与操作数间不需要空格。如a+=c+d;《安全生产信息化管理系统》程序员开发手册——————————————————————————————————————————————4a=(a+b)/(c*d);while(d++=s++){n++;}PrintSize(“sizeis“+size+“\n”);3、语句中的表达式之间用空格隔开。如for(expr1;expr2;expr3)4、以下写法是不允许的：intj=i+k;2.6括号-()1、左括号“(”不要紧靠关键字，中间用一个空格隔开。2、左括号“(”与方法名之间不要添加任何空格。3、没有必要的话不要在返回语句中使用()。如if(condition)Array.Remove(1)return12.7花括号-{}1、左花括号“{”放于关键字或方法名的下一行并与之对齐。如if(condition){}publicintAdd(intx,inty){}2、左花括号“{”要与相应的右花括号“}”对齐。3、通常情况下左花括号“{”单独成行，不与任何语句并列一行。4、if、while、do语句后一定要使用{}，即使{}号中为空或只有一条语句。如if(somevalue==1)《安全生产信息化管理系统》程序员开发手册——————————————————————————————————————————————5{somevalue=2;}右花括号“}”后建议加一个注释以便于方便的找到与之相应的{。如while(1){if(valid){}//ifvalidelse{}//notvalid}//endforever以下情况是不允许的：if(x==0){Response.Write(用户编号必须输入！);}或者：if(x==0){Response.Write(用户编号必须输入！);}2.8分解将大的复杂代码节分为较小的、易于理解的模块。2.9SQL1、编写SQL语句时，对于关键字或保留字使用全部大写，对于数据库元素（如表、列和视图等命名）使用帕斯卡命名法命名。如：SELECTUserIdASEmIdFROMUserSELECTUserIdASEmIdFROMUserASemSELECTUserIdASEmIdFROMUserASEM等允许使用；2、将每个主要的SQL子句放在不同的行上，这样更容易阅读和编辑语句。例如：SELECTFirstName,LastNameFROMCustomersWHEREState='WA';3、不要从数据表中调用页面或程序不需要的字段；《安全生产信息化管理系统》程序员开发手册——————————————————————————————————————————————62.10引用1、对于程序中字段名称的引用要通过对应的属性调用实现。如：IntuserId=(int)Dv[0][“UserId”];是不允许的；IntuserId=(int)Dv[0][User.x.UserId.ColumnName];是允许的；stringbookPriceName=Book.x.BookPrice.ColumnName;decimal?bookPrice=null;if(dr[bookPriceName]!=DBNull.Value){bookPrice=(decimal)dr[bookPriceName];}是允许的；3程序注释3.1注释概述1、修改代码时，总是使代码周围的注释保持最新。2、在每个例程的开始，提供标准的注释样本以指示例程的用途、假设和限制很有帮助。注释样本应该是解释它为什么存在和可以做什么的简短介绍。3、避免在代码行的末尾添加注释；行尾注释使代码更难阅读。不过在批注变量声明时，行尾注释是合适的；在这种情况下，将所有行尾注释在公共制表位处对齐。4、避免杂乱的注释，如一整行星号。而是应该使用空白将注释同代码分开。5、避免在块注释的周围加上印刷框。这样看起来可能很漂亮，但是难于维护。6、在部署发布之前，移除所有临时或无关的注释，以避免在日后的维护工作中产生混乱。7、如果需要用注释来解释复杂的代码节，请检查此代码以确定是否应该重写它。尽一切可能不注释难以理解的代码，而应该重写它。尽管一般不应该为了使代码更简单以便于人们使用而牺牲性能，但必须保持性能和可维护性之间的平衡。8、在编写注释时使用完整的句子。注释应该阐明代码，而不应该增加多义性。9、在编写代码时就注释，因为以后很可能没有时间这样做。另外，如果有机会《安全生产信息化管理系统》程序员开发手册——————————————————————————————————————————————7复查已编写的代码，在今天看来很明显的东西六周以后或许就不明显了。10、避免多余的或不适当的注释，如幽默的不主要的备注。11、使用注释来解释代码的意图。它们不应作为代码的联机翻译。12、注释代码中不十分明显的任何内容。13、为了防止问题反复出现，对错误修复和解决方法代码总是使用注释，尤其是在团队环境中。14、对由循环和逻辑分支组成的代码使用注释。这些是帮助源代码读者的主要方面。15、在整个应用程序中，使用具有一致的标点和结构的统一样式来构造注释。16、用空白将注释同注释分隔符分开。在没有颜色提示的情况下查看注释时，这样做会使注释很明显且容易被找到。17、在所有的代码修改处加上修改内容的注释（此项只供参考）。18、对于常量、变量、表达式等使用单行注释时建议放到声明的后面；19、对于常量、变量、表达式等建议使用单行注释，单行注释格式如：privateintnumber;//注释语句或：////注释语句privateintnumber;20、为了使层次清晰，在闭合的右花括号后注释该闭合所对应的起点（此项只供参考）。namespaceLangchao.Procument.Web{}//namespaceLangchao.Procument.Web3.2文档型注释该类注释采用.Net已定义好的Xml标签来标记，在声明接口、类、方法、属性、字段都应该使用该类注释，以便代码完成后直接生成代码文档，让别人更好的了解代码的实现和接口。如///summaryMyMethodisamethodintheMyClassclass.///paraHere'showyoucouldmakeasecondparagraphina《安全生产信息化管理系统》程序员开发手册——————————————————————————————————————————————8description.///seecref=System.Console.WriteLine////forinformationaboutoutputstatements.////para///seealsocref=MyClass.Main/////summarypublicstaticvoidMyMethod(intInt1){}又如：类属性注释规范在类的属性必须以以下格式编写属性注释：///summary///属性说明////summary方法注释规范在类的方法声明前必须以以下格式编写注释///summary///说明：对该方法的说明////summary///paramname=参数名称参数说明/param///returns///对方法返回值的说明，该说明必须明确说明返回的值代表什么含义////returns3.3类c注释（此项只供参考）该类注释用于1、不再使用