天强绩效考核系统开发命名规范.docVIP

天强绩效管理系统 编程规范 命名规范 命名原则 Pascal Casing 属性每个单词的第一个字母大写，例如：BackColor Camel Casing 除了第一个单词以外的每个单词的第一个字母大写，例如：backColor. Upper Casing 如果缩写字母的个数小于或等于2，那么所有的缩写字母都大写。3个以上的字母 缩写采用Pascal Casing。例如：System.IO, System.Web.UI, System.CodeDom。 类的命名 用Pascal Casing 命名规则 谨慎的使用缩写 不要使用任何的前缀（例如：C_GetList） 不要使用下划线命名 已所拥有的功能作为描述命名 方法的命名 用Pascal Casing 命名规则 谨慎的使用缩写 用动词或动词短语来命名（例如：public string GetAllList(){}） Data层的方法统一使用 Insert() 添加数据 Update() 修改数据 GetModel() 获取一条数据 GetModelList() 获取一个列表 Delete() 删除数据 不要使用下划线命名 属性的命名 用Pascal Casing 命名规则 谨慎的使用缩写 用名词或名词短语来命名 不要使用下划线命名 可以考虑用类型名称作为属性名称（例如： public Color Color{}） 接口的命名 用Pascal Casing 命名规则 谨慎的使用缩写 接口的前缀命名统一用I（方法本身的描述中有I开头的除外，例如：IGetPolicy） 不要使用下划线命名 接口名字用名词或者名词短语，或形容词来表述接口的行为 参数的命名 用Camel Casing 命名规则 谨慎的使用缩写 由本地的参数类型+描述性单词（例如：objCompanyList, strName, nCode） 不要使用保留参数（Win32 API） 参数的名字应该是描述性的 变量的命名 用Camel Casing 命名规则 避免无意义的变量命名（如：string a = string.Empty()，但 for(int i=0;i5;i++)除外） 由本地的参数类型+描述性单词（例如：objCompanyList, strName, intCode） 不要使用保留参数（Win32 API） 参数的名字应该是描述性的 大小写敏感 不要出现两个只用大小写区分的命名空间 不要出现两个只用大小写区分的参数 不要出现两个只用大小写区分的同一命名空间的类型 不要出现两个只用大小写区分的同一类型属性 不要出现两个只用大小写区分的方法 类库的命名 要以系统的功能模块来划分类库，所有的类库的命名空间用KPI. 开头 用Pascal Casing 命名规则 不要使用下划线命名 不能使用缩写 类库分为公共引用层，实体层，逻辑层和数据层类库 公共引用层命名 Common 实体层命名 KPI.Model，例如：KPI.Model.Syetem 逻辑层命名 KPI.Stategy. 例如：KPI.Stategy.System 数据层命名 KPI.Data. 例如：KPI.Data.System 文件的命名 用Pascal Casing 命名规则 公共引用层文件命名参考类的命名 Web网站内文件的命名 主要遵循 Pascal Casing 命名规则 实体层文件命名分为 数据库实体，自定义实体, 条件实体。 实体层数据库实体文件命名 数据库名称 + Model结尾命名 实体层自定义实体文件命名 功能描述名词 + Define结尾命名 实体层条件实体功能描述名词 + Condition结尾命名 逻辑层文件命名 功能描述名词 数据层文件命名 数据库名称 编程规范 代码注释 原则上平均每100行代码中要有20～30行注释，视程序复杂程度而定。 所有注释应使用中文。例如://添加一个用户函数 对于源文件和类，必须在注释中说明修改历史 具体规范参见项目根目录下的CodingSample.cs 类和接口的注释 在summary中填写类的简要描述，remarks中填写类的一些注意事项。Histroy填写修改记录。 所有类和接口都要注释。类的操作注释由详细设计产物导出，编程人员补充完成从Title到History的部分。 例如： /// summary /// see cref=IUserManager/接口定义了see cref=User/实体类的增、删、改、读 /// （CRUD）方法，该接口的实现类将负责用户对象的简单管理。 /// /summary /// remarks /// see cref=IUserManager/接口仅定义see cref=User/实体对