《C#编码规范》.pptx

一、概述二、实例讲解三、注意点四、QpublicconststringPAGE_TITLE=Welcome;,实例讲解,C#的编码规范变量变量在定义的时候，需要根据变量的数据类型添加不同的前缀(前缀全部小写)，但不需要区分其作用域。另外，变量的命名规则采用数据类型前缀+Pascal命名规范。如：privatestringstrName=“”;,实例讲解,实例讲解,C#的编码规范变量C#中各常用的变量的前缀如下表所示：,实例讲解,C#的编码规范变量C#中各常用的变量的前缀如下表所示(续)：,实例讲解,C#的编码规范变量C#中各常用的变量的前缀如下表所示(续)：,实例讲解,C#的编码规范参数在方法定义中的形参，采用Pascal命名方法，不需要根据数据类型来添加前缀，作为调用方法时传递的实参，则采用上面变量的命名规则，使用数据类型前缀+Pascal命名方法。驼峰命名规范如：voidSetName(stringname)调用的时候，可以如下：stringstrName=“abc”;SetName(strName);,实例讲解,C#的编码规范代码格式代码的格式包括缩进、换行、空行、空格等，为了不影响编码的效率，在此只作如下规定：空格、空行不做严格的固定，以使代码清晰为基本原则。空行不影响程序的运行，但可以使代码看起来清晰，增加可读性，因此可以适当的多用。代码的缩进建议使用tab键进行控制，tab键的大小设置为4个空格。每个层次都要进行缩进。如：if(isOverFlow)returnfalse;/endif换行，掌握的原则是不要使一行代码特别的长，再不产生严重歧义或增加阅读难度的情况下，尽量控制在110列之内，以方便代码的打印。另外，换行的原则是，在逗号后，操作符前换行，换行与首行要保持一个单位的缩进。如：stringstrSql=“SELECTID,NAME,SEX,BIRTHDAY,”+“BELONGCLASSID,BELONGGRADEID“+“FROMSTUDENTINFO”;必须单独在一行上，且上下对齐。if，while，do，try-catch-finally等语句后必须有,即使里面只有一条语句或为空。,实例讲解,C#的编码规范代码格式列宽代码列宽控制在屏幕宽度以内。110字符左右为宜。每行长度尽量避免超过屏幕宽度换行当表达式超出或即将超出规定的列宽，遵循以下规则进行换行1、在逗号后换行。2、在操作符前换行。3、规则1优先于规则2。当以上规则会导致代码混乱的时候自己采取更灵活的换行规则。缩进缩进应该是每行一个Tab(4个空格)，不要在代码中使用Tab字符。VisualStudio.Net设置：工具-选项-文本编辑器-C#-制表符-插入空格。,实例讲解,C#的编码规范代码格式空行空行是为了将逻辑上相关联的代码分块，以便提高代码的可阅读性。在以下情况下使用两个空行1、接口和类的定义之间。2、枚举和类的定义之间。3、类与类的定义之间。在以下情况下使用一个空行1、方法与方法、属性与属性之间。2、方法中变量声明与语句之间。3、方法与方法之间。4、方法中不同的逻辑块之间。5、方法中的返回语句与其他的语句之间。6、属性与方法、属性与字段、方法与字段之间。7、注释与它注释的语句间不空行，但与其他的语句间空一行。,实例讲解,C#的编码规范代码格式空格在以下情况中要使用到空格1、关键字和左括符“(”应该用空格隔开。如while(true)；注意在方法名和左括符“(”之间不要使用空格，这样有助于辨认代码中的方法调用与关键字。2、多个参数用逗号隔开，每个逗号后都应加一个空格。3、除了.之外，所有的二元操作符都应用空格与它们的操作数隔开。一元操作符、+及-与操作数间不需要空格。如a+=c+d;a=(a+b)/(c*d);while(d+=s+)n+;PrintSize(sizeis+size+n);4、语句中的表达式之间用空格隔开。如for(expr1;expr2;expr3)。,实例讲解,C#的编码规范代码格式括号-()1、左括号“(”不要紧靠关键字，中间用一个空格隔开。2、左括号“(”与方法名之间不要添加任何空格。3、没有必要的话不要在返回语句中使用()。如if(condition)Array.Remove(1)；return1；,实例讲解,C#的编码规范代码格式花括号-1、左花括号“”放于关键字或方法名的下一行并与之对齐。如publicintAdd(intx,inty)2、左花括号“”要与相应的右花括号“”对齐。3、通常情况下左花括号“”单独成行，不与任何语句并列一行。4、if、while、do语句后一定要使用，即使号中为空或只有一条语句。如if(somevalue=1)somevalue=2;,实例讲解,C#的编码规范代码格式花括号-5、右花括号“”后建议加一个注释以便于方便的找到与之相应的。如while(1)if(valid)/ifvalidelse/notvalid/endforever,实例讲解,C#的编码规范注释要养成良好的代码注释习惯，通常，注释要占实际代码总行数的1/3，同时，要在编写代码前或编写代码的同时进行代码的注释，不要事后补写注释。注释分为多行注释和单行注释，我们的原则是：在类和方法的前面，要写多行注释，在定义类的全局变量/常量，以及方法的内部，使用单行注释。注释的前面与代码之间要有空行。单行注释，我们鼓励都要单独一行，不鼓励在语句的后面使用注释，当然，在变量定义的后面使用注释也是允许的。另外，在编写注释的时候，建议使用C#自己的注释风格，即在类的前面和方法的前面使用“/”进行注释。,实例讲解,C#的编码规范注释（续）特别注意，如果是在已经发行版本的基础上添加、修改、删除代码，则需要将原先的代码注释掉，而不是直接删除掉，然后添加自己的代码。如：添加新代码的注释：/addby姓名yyyyMMddxxx/addby姓名yyyyMMdd修改代码的注释：/updateby姓名yyyyMMdd/xxxyyy/updateby姓名yyyyMMdd删除代码的注释：/deleteby姓名yyyyMMdd/xxx/deleteby姓名yyyyMMdd,实例讲解,C#的编码规范方法和函数注释/获取分页SQL/表名/每页显示条数/第几页/排序字段（最后一个不需要填写正序还是倒序，例如：idasc,name）/最后一个排序字段的正序或倒序（true为倒序，false为正序）/条件/返回用于分页的SQL语句privatestringGetPagerSQL(stringtblName,intpageSize,intpageIndex,stringfldSort,boolfldDir,stringcondition)code;,实例讲解,C#的编码规范区域#region把相同性质的相关代码分组包含起来，如一组事件，方法，属性，字段等；如果内容少允许不包。原因：如果一个类比较长，归类可以方便阅读和查找。如果归类后的某层还很大，可以考虑里面再按用途归类。,实例讲解,C#的编码规范声明每行只定义一个声明，多个声明要分多行来定义。如：intintAge,intWeight;/不推荐应使用如下的定义形式：intintAge;intintWeight;声明的位置：变量要在块的开始的地方集中进行声明，不要何时用到何时临时定义。,实例讲解,ASP.NET编码规范ASP.NET方面的编码规范主要是控件命名方面的规范，其他的请参照C#的编码规范,实例讲解,ASP.NET编码规范ASP.NET方面的编码规范主要是控件命名方面的规范，其他的请参照C#的编码规范（续）,实例讲解,ASP.NET编码规范ASP.NET方面的编码规范主要是控件命名方面的规范，其他的请参照C#的编码规范（续）,实例讲解,ASP.NET编码规范ASP.NET方面的编码规范主要是控件命名方面的规范，其他的请参照C#的编码规范（续）,实例讲解,C#的编码规范类型转换1、尽量避免强制类型转换。2、如果不得不做类型转换，尽量用显式方式。,友情提示：良好的命名对于软件开发起着至关重要的作用，能够对资源进行合理的命名，可以达到事半功倍的效果。无论是哪种命名规