代码编写规范

一.目的

　　为了更好的提高工作效率，保证开发的有效性和合理性，并可最大程度的提高程序代码的可读性和可重复利用性，便于交流和维护

 

二、命名总体规范

　　名字应该能够标识事物的特性，并且与业务挂钩。
名字一律使用英文单词，而不能为拼音。
名字可以有两个或三个单词组成，但不应多于4个，控制在3至30个字母以内。
在名字中，多个单词用大写第一个字母（其它字母小写）来分隔。例如：IsSuperUser。
比较流行的命名方法
Pascal命名法（大驼峰法）：所有单词的首字母都大写，其他字母小写。例如MyFirstName
Camel命名法（小驼峰法）：除首字母外，其他单词的首字母大写，其他字母小写。例如myFirstName
参数
参数名称使用Camel大小写批注[梦10]:
参数名称可缩写
方法
以动词开头。批注[梦11]:
使用Pascal大小写。
禁止缩写，除非名词本身含有缩写。如：AddStudentMgr()
属性(property)
以名词或形容词命名。批注[梦12]:
使用Pascal大小写。
禁止缩写
事件
使用Pascal大小写。
禁止缩写。
名称命名使用Event后缀。
用动词或名词命名，带有时间意义，如：MouseMove事件、Closing事件、Closed事件。
指定两个名为sender和e的参数。sender参数表示引发事件的对象。e为事件类的实例。e参数类型使用适当而特定的事件类。
用EventArgs后缀命名事件参数类。
注释
在模块、类、属性、方法前一行添加注释，以便调用的时候提示用户
代码中遇到语句块时必须添加注释（if,for,foreach,……）,添加的注释必须能够说明此语句块的作用和实现手段（所用算法、循环条件、不同分支的意义等等）。