编码规范.ppt

文档介绍：编码规范
1
编码规范概述
编码规范的必要性
有助于程序的维护,降低软件生命周期成本,符合项目管理的规律
使团队中相关人员的流动对项目的影响尽可能小,有利于项目的控制与管理;
提高程序的可读性,有利于相关设计人员交流,提高软件质量;
容易发现代码的问题,调试时比较容易
体现公司形象
2
编码规范的要点
排版规范(缩进、空行)
注释规范清晰
类名、方法名定义规范(大小写)
变量定义规范(大小写、变量有意义)
编码规范概述
3
实例讲解
C#的编码规范
SQL的编码规范
的编码规范
4
C#的编码规范
制定原则
1 中,C#既有的规范来制定
2 方便代码的交流和维护。
3 不影响编码的效率,不与大众****惯冲突。
4 使代码更美观、阅读更方便。
5 使代码的逻辑更清晰、更易于理解。
遵守原则
首先遵守客户要求的规则
在客户没有指定规则的情况下,遵守本规则
实例讲解
5
C#的编码规范
文件/类的命名规则
方法的命名规则
常量、变量、参数的定义规则
代码的格式
注释的书写格式
效率方面注意的问题
实例讲解
6
实例讲解
C#的编码规范
术语定义:
Pascal 大小写
将标识符的首字母和后面连接的每个单词的首字母都大写。可以对三字符或更多字符的标识符使用Pascal 大小写。例如:
BackColor
Camel 大小写
标识符的首字母小写,而每个后面连接的单词的首字母都大写。例如:
backColor
7
实例讲解
C#的编码规范
文件的命名规则
文件的命名采用Pascal命名规则,无特殊情况,文件的扩展名小写。
文件的扩展名使用统一而且通用的扩展名,如C#类使用扩展名:.cs
例如:


8
实例讲解
C#的编码规范
类的命名规则
类的名字必须是有意义的,且与类实现的功能或业务逻辑相关的名字。
除接口类的其他所有类(包括普通类、抽象类等)都采用Pascal命名法,且主类的名字与文件名一致。
接口类有自己特殊的命名规则:类的前缀为“I”,后面连接Pascal命名法所起的有意义的名字。同样,类名与文件名相同,如:IFormatable。
9
实例讲解
C#的编码规范
方法的命名规则
按照C#语言本身的原始特征,方法的命名采用Pascal命名规则。另外,方法的命名应该说明的是“做什么”,而不是“如何做”;方法的名称应该足够长以便有一定的意义,又应该足够短,以避免冗长。
如:
WriteToFile()。
10