1 / 19
文档名称:

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

格式:docx   大小:23KB   页数:19页
下载后只包含 1 个 DOCX 格式的文档,没有任何的图纸或源代码,查看文件列表

如果您已付费下载过本站文档,您可以点这里二次下载

分享

预览

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

上传人:fangjinyan2017001 2021/10/9 文件大小:23 KB

下载得到文件列表

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

相关文档

文档介绍

文档介绍:天强绩效管理系统
编程规范
一. 命名规范
命名原则
PascalCasing
属性每个单词的第壹个字母大写,例如: BackColor
CamelCasing
除了第壹个单词以外的每个单词的第壹个字母大写,例如: backColor.
UpperCasing
如果缩写字母的个数小于或等于 2 ,那么所有的缩写字母均大写。 3 个之上的字母
缩写采用 PascalCasing 。例如: ,, 。
类的命名
用 PascalCasing 命名规则
谨慎的使用缩写
不要使用任何的前缀(例如: C_GetList )
不要使用下划线命名
已所拥有的功能作为描述命名
方法的命名
用 PascalCasing 命名规则
谨慎的使用缩写
(例如: publicstringGetAllList(){} )
Data层的方法统壹使用
Insert()
添加数据
Update()
修改数据
GetModel()
获取壹条数据
GetModelList()
获取壹个列表
Delete()
删除数据

属性的命名
命名规则



(例如: publicColorColor{})
接口的命名
命名规则

I (方法本身的描述中有 I开头的除外,例如:IGetPolicy )
不要使用下划线命名
接口名字用名词或者名词短语,或形容词来表述接口的行为
参数的命名
用 CamelCasing 命名规则
谨慎的使用缩写
由本地的参数类型 + 描述性单词(例如: objCompanyList,strName,nCode )
不要使用保留参数( Win32API )
参数的名字应该是描述性的
变量的命名
用 CamelCasing 命名规则
避免无意义的变量命名 (如: stringa=() , 但 for(inti=0;i<5;i++) 除外)
由本地的参数类型 + 描述性单词(例如: objCompanyList,strName,intCode )
不要使用保留参数( Win32API )
参数的名字应该是描述性的
大小写敏感
不要出现俩个只用大小写区分的命名空间
不要出现俩个只用大小写区分的参数
不要出现俩个只用大小写区分的同壹命名空间的类型
不要出现俩个只用大小写区分的同壹类型属性
e. 不要出现俩个只用大小写区分的方法
类库的命名

要以系统的功能模块来划分类库,所有的类库的命名空间用
用 PascalCasing 命名规则
不要使用下划线命名
不能使用缩写
类库分为公共引用层,实体层,逻辑层和数据层类库
公共引用层命名 Common
实体层命名 ,例如:
逻辑层命名 . 例如:
数据层命名 . 例如:
文件的命名
用 PascalCasing 命名规则
公共引用层文件命名参考类的命名
Web 网站内文件的命名主要遵循 PascalCasing 命名规则
实体层文件命名分为数据库实体,自定义实体 ,条件实体。
实体层数据库实体文件命名数据库名称 +Model 结尾命名
实体层自定义实体文件命名功能描述名词 +Define 结尾命名
实体层条件实体功能描述名词 +Condition 结尾命名
逻辑层文件命名功能描述名词
数据层文件命名数据库名称
编程规范
代码注释
原则上平均每100行代码中要有20〜30行注释,视程序复杂程度而定。
所有注释应使用中文。例如 :// 添加壹个用户函数
对于源文件和类,必须于注释中说明修改历史
具体规范参见项目根目录下的
类和接口的注释
于 <summary> 中填写类的简要描述, <remarks> 中填写类的壹些注意事项。 Histroy
填写修改记录。
所有类和接口均要注释。类的操作注释由详细设计产物导出,编程人员补充完成从 Title
到 History 的部分。
例如:
///<summary>
///<seecref="IUserManager"/