编程代码规范讲座().pptVIP

代码规法 陈琨 概述 代码注释 标识符命名 执行效率 函数 程序备份 概述 规范制定原则 1 方便代码的交流和维护。 2 不影响编码的效率，不与大众习惯冲突。 3 使代码更美观、阅读更方便。 4 使代码的逻辑更清晰、更易于理解。 术语定义 Pascal 大小写 将标识符的首字母和后面连接的每个单词的首字母都大写。可以对三字符或更多字符的标识符使用Pascal 大小写。例如：BackColor Camel 大小写 标识符的首字母小写，而每个后面连接的单词的首字母都大写。例如：backColor 文件命名组织 文件命名 1 文件名遵从Pascal命名法，无特殊情况，扩展名小写。 2 使用统一而又通用的文件扩展名： C# 类 .cs 注释 一般情况下，源程序有效注释量必须在20％以上。 说明：注释的原则是有助于对程序的阅读理解，在该加的地方都加了，注释不宜太多也不能太少，注释语言必须准确、易懂、简洁。 文件头部应进行注释，列出：版权说明、版本号、生成日期、作者、模块目的/功能、主要函数及其功能、修改日志等。 函数头部应进行注释，列出：函数的目的/功能、输入参数、输出参数、返回值、调用关系（函数、表）等。 5.边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。不再有用的注释要删除。 6.注释的内容要清楚、明了，含义准确，防止注释二义性。 说明：错误的注释不但无益反而有害。 7.避免在注释中使用缩写，特别是非常用缩写。 说明：在使用缩写时或之前，应对缩写进行必要的说明。 8.注释应与其描述的代码相近，对代码的注释应放在其上方或右方（对单条语句的注释）相邻位置，不可放在下面，如放于上方则需与其上面的代码用空行隔开。 代码外观 1 列宽 代码列宽控制在110字符左右。 2 换行 当表达式超出或即将超出规定的列宽，遵循以下规则进行换行 1、在逗号后换行。 2、在操作符前换行。 3、规则1优先于规则2。 当以上规则会导致代码混乱的时候自己采取更灵活的换行规则。 3 缩进 缩进应该是每行一个Tab(4个空格)，不要在代码中使用Tab字符。 Visual Studio.Net设置：工具-选项-文本编辑器-C#-制表符-插入空格 4 空行 空行是为了将逻辑上相关联的代码分块，以便提高代码的可阅读性。 在以下情况下使用两个空行 1、接口和类的定义之间。 2、枚举和类的定义之间。 3、类与类的定义之间。 在以下情况下使用一个空行 1、方法与方法、属性与属性之间。 2、方法中变量声明与语句之间。 3、方法与方法之间。 4、方法中不同的逻辑块之间。 5、方法中的返回语句与其他的语句之间。 6、属性与方法、属性与字段、方法与字段之间。 7、注释与它注释的语句间不空行，但与其他的语句间空一行。 5 空格 在以下情况中要使用到空格 1、 关键字和左括符 “(” 应该用空格隔开。如while (true) 注意在方法名和左括符 “(” 之间不要使用空格，这样有助于辨认代码中的方法调用与关键字。 多个参数用逗号隔开，每个逗号后都应加一个空格。除了 . 之外，所有的二元操作符都应用空格与它们的操作数隔开。一元操作符、++及--与操作 数间不需要空格。如 a += c + d; a = (a + b) / (c * d); while (d++ = s++) { n++; } PrintSize(“size is “ + size + “\n”); 2、 语句中的表达式之间用空格隔开。如 for (expr1; expr2; expr3) 6 括号 - () 1、 左括号“(” 不要紧靠关键字，中间用一个空格隔开。 2、 左括号“(” 与方法名之间不要添加任何空格。 3、 没有必要的话不要在返回语句中使用()。如 if (c