C#编码规范导论.ppt

编 码 规 范 一、概述 二、实例讲解 三、注意点 四、QA 编码规范 编码规范概述 /* * 补齐长度 (不足长度的在前面补0) */ public static String SupplyLength(String strIn, int intLength) { String strReturnValue = ; int intNum; //希望长度与现有长度的差值 intNum = intLength - strIn.Length; strReturnValue = strIn; //按照长度差值，在前面补充“0” for (int i = 0; i intNum; i++) { strReturnValue = 0 + strReturnValue; } return strReturnValue; } /* * 补齐长度 (不足长度的在前面补0) */ public static String SupplyLength(String a, int b) { String x = ; int i; i = b - a.Length; x = a; for (int j = 1; j = i; j++) { x = 0 + x; } return x; } 编码规范概述 SELECT STUDENT.STUDENTID, STUDENT.NAME, STUDENT.SEX, STUDENT.BIRTHDAY, CLASS.CLASSNAME FROM STUDENT, CLASS WHERE STUDENT.BELONGCLASSID=CLASS.CLASSID AND STUDENT.NAME=‘张三’ SELECT A.STUDENTID,A.NAME, A.SEX,A.BIRTHDAY,B.CLASSNAME FROM STUDENT A,CLASS B WHERE A.BELONGCLASSID = B.CLASSID AND A.NAME =‘张三’ 编码规范概述 编码规范的必要性 多人协作时，代码清晰易懂 容易发现代码的问题，调试时比较容易 体现公司形象 编码规范的要点 排版规范（缩进、空行） 注释规范清晰 类名、方法名定义规范（大小写） 变量定义规范（大小写、变量有意义） 实例讲解 C#的编码规范 SQL的编码规范 ASP.NET的编码规范 实例讲解 C#的编码规范 制定原则 1 参照微软在VS.NET中，C#既有的规范来制定 2 方便代码的交流和维护。 3 不影响编码的效率，不与大众习惯冲突。 4 使代码更美观、阅读更方便。 5 使代码的逻辑更清晰、更易于理解。 遵守原则 首先遵守客户要求的规则 在客户没有指定规则的情况下，遵守本规则 实例讲解 C#的编码规范 文件/类的命名规则 方法的命名规则 常量、变量、参数的定义规则 代码的格式 注释的书写格式 效率方面注意的问题 实例讲解 C#的编码规范 术语定义： Pascal 大小写 将标识符的首字母和后面连接的每个单词的首字母都大写。可以对三字符或更多字符的标识符使用Pascal 大小写。 例如： BackColor Camel 大小写 标识符的首字母小写，而每个后面连接的单词的首字母都大写。例如： backColor 匈牙利 大小写 标示符的首字母用类型的简写，而每个后面连接的单词的首字母 大写。例如： strBackColor 标志符 大小写方式 示例 类 Pascal AppDomain 枚举类型 Pascal ErrorLevel 枚举值 Pascal FatalError 事件 Pascal ValueChanged 异常类 Pascal WebException 只读的静态字段 Pascal RedValue 接口 IPascal IDisposable 方法 Pascal ToString 命名空间 Pascal System.Drawing 参数 camel typeName 属性 Pascal BackColor 中间层方法接口 IPascal ILogin 私有字段 _camel _userName 控件命名 _匈牙利 _txtUserName 局部变量 camel / 匈牙利 textLength / iLength Pascal camel 错误写法 BitFlag bitFlag Bitflag Callback callback CallBack