上海某公司绩效管理系统编程规范VIP免费

第1页共11页编号：时间：2021年x月x日书山有路勤为径，学海无涯苦作舟页码：第1页共11页天强绩效管理系统编程规范第2页共11页第1页共11页编号：时间：2021年x月x日书山有路勤为径，学海无涯苦作舟页码：第2页共11页一．命名规范1.命名原则a.PascalCasing属性每个单词的第一个字母大写，例如：BackColorb.CamelCasing除了第一个单词以外的每个单词的第一个字母大写，例如：backColor.c.UpperCasing如果缩写字母的个数小于或等于2，那么所有的缩写字母都大写。3个以上的字母缩写采用PascalCasing。例如：System.IO,System.Web.UI,System.CodeDom。2.类的命名a.用PascalCasing命名规则b.谨慎的使用缩写c.不要使用任何的前缀（例如：C_GetList）d.不要使用下划线命名e.已所拥有的功能作为描述命名3.方法的命名a.用PascalCasing命名规则b.谨慎的使用缩写c.用动词或动词短语来命名（例如：publicstringGetAllList(){}）Data层的方法统一使用d.不要使用下划线命名Insert()添加数据Update()修改数据GetModel()获取一条数据GetModelList()获取一个列表Delete()删除数据第3页共11页第2页共11页编号：时间：2021年x月x日书山有路勤为径，学海无涯苦作舟页码：第3页共11页4.属性的命名a.用PascalCasing命名规则b.谨慎的使用缩写c.用名词或名词短语来命名d.不要使用下划线命名e.可以考虑用类型名称作为属性名称（例如：publicColorColor{}）5.接口的命名a.用PascalCasing命名规则b.谨慎的使用缩写c.接口的前缀命名统一用I（方法本身的描述中有I开头的除外，例如：IGetPolicy）d.不要使用下划线命名e.接口名字用名词或者名词短语，或形容词来表述接口的行为6.参数的命名a.用CamelCasing命名规则b.谨慎的使用缩写c.由本地的参数类型+描述性单词（例如：objCompanyList,strName,nCode）d.不要使用保留参数（Win32API）e.参数的名字应该是描述性的7.变量的命名a.用CamelCasing命名规则b.避免无意义的变量命名（如：stringa=string.Empty()，但for(inti=0;i<5;i++)除外）c.由本地的参数类型+描述性单词（例如：objCompanyList,strName,intCode）d.不要使用保留参数（Win32API）e.参数的名字应该是描述性的8.大小写敏感a.不要出现两个只用大小写区分的命名空间b.不要出现两个只用大小写区分的参数c.不要出现两个只用大小写区分的同一命名空间的类型d.不要出现两个只用大小写区分的同一类型属性e.不要出现两个只用大小写区分的方法9.类库的命名a.要以系统的功能模块来划分类库，所有的类库的命名空间用KPI.开头b.用PascalCasing命名规则c.不要使用下划线命名d.不能使用缩写第4页共11页第3页共11页编号：时间：2021年x月x日书山有路勤为径，学海无涯苦作舟页码：第4页共11页e.类库分为公共引用层，实体层，逻辑层和数据层类库f.公共引用层命名Commong.实体层命名KPI.Model，例如：KPI.Model.Syetemh.逻辑层命名KPI.Stategy.例如：KPI.Stategy.Systemi.数据层命名KPI.Data.例如：KPI.Data.System10.文件的命名a.用PascalCasing命名规则b.公共引用层文件命名参考类的命名c.Web网站内文件的命名主要遵循PascalCasing命名规则d.实体层文件命名分为数据库实体，自定义实体,条件实体。e.实体层数据库实体文件命名数据库名称+Model结尾命名f.实体层自定义实体文件命名功能描述名词+Define结尾命名g.实体层条件实体功能描述名词+Condition结尾命名h.逻辑层文件命名功能描述名词i.数据层文件命名数据库名称二．编程规范1.代码注释原则上平均每100行代码中要有20～30行注释，视程序复杂程度而定。所有注释应使用中文。例如://添加一个用户函数对于源文件和类，必须在注释中说明修改历史具体规范参见项目根目录下的CodingSample.cs2.类和接口的注释在

中填写类的简要描述，中填写类的一些注意事项。Histroy填写修改记录。所有类和接口都要注释。类的操作注释由详细设计产物导出，编程人员补充完成从Title到History的部分。例如：///

///接口定义了实体类的增、删、改、读///（CRUD）方法，该接口的实现类将负责用户对象的简单管理。///