上海公司绩效管理系统编程规范

1、 天强绩效治理系统编程规范命名规范命名原则Pascal Casing属性每个单词的第一个字母大写，例如：BackColorCamel Casing 除了第一个单词以外的每个单词的第一个字母大写，例如：backColor.Upper Casing假如缩写字母的个数小于或等于2，那么所有的缩写字母都大写。3个以上的字母缩写采纳Pascal Casing。例如：System.IO, System.Web.UI, System.CodeDom。类的命名用Pascal Casing 命名规则慎重的使用缩写不要使用任何的前缀（例如：C_GetList）不要使用下划线命名已所拥有的功能作为描述命名方法的命名

2、用Pascal Casing 命名规则慎重的使用缩写用动词或动词短语来命名（例如：public string GetAllList()）Data层的方法统一使用Insert()添加数据Update()修改数据GetModel()猎取一条数据GetModelList()猎取一个列表Delete()删除数据不要使用下划线命名属性的命名用Pascal Casing 命名规则慎重的使用缩写用名词或名词短语来命名不要使用下划线命名能够考虑用类型名称作为属性名称（例如： public Color Color）接口的命名用Pascal Casing 命名规则慎重的使用缩写接口的前缀命名统一用I（方法本身的描

3、述中有I开头的除外，例如：IGetPolicy）不要使用下划线命名接口名字用名词或者名词短语，或形容词来表述接口的行为参数的命名用Camel Casing 命名规则慎重的使用缩写由本地的参数类型+描述性单词（例如：objCompanyList, strName, nCode）不要使用保留参数（Win32 API）参数的名字应该是描述性的变量的命名用Camel Casing 命名规则幸免无意义的变量命名（如：string a = string.Empty()，但 for(int i=0;i5;i+)除外）由本地的参数类型+描述性单词（例如：objCompanyList, strName, int

4、Code）不要使用保留参数（Win32 API）参数的名字应该是描述性的大小写敏感不要出现两个只用大小写区分的命名空间不要出现两个只用大小写区分的参数不要出现两个只用大小写区分的同一命名空间的类型不要出现两个只用大小写区分的同一类型属性不要出现两个只用大小写区分的方法类库的命名要以系统的功能模块来划分类库，所有的类库的命名空间用KPI. 开头用Pascal Casing 命名规则不要使用下划线命名不能使用缩写类库分为公共引用层，实体层，逻辑层和数据层类库公共引用层命名 Common实体层命名 KPI.Model，例如：KPI.Model.Syetem逻辑层命名 KPI.Stategy. 例如：

5、KPI.Stategy.System数据层命名 KPI.Data. 例如：KPI.Data.System 文件的命名用Pascal Casing 命名规则公共引用层文件命名参考类的命名Web网站内文件的命名 要紧遵循 Pascal Casing 命名规则实体层文件命名分为 数据库实体，自定义实体, 条件实体。 实体层数据库实体文件命名 数据库名称 + Model结尾命名实体层自定义实体文件命名 功能描述名词 + Define结尾命名实体层条件实体功能描述名词 + Condition结尾命名逻辑层文件命名 功能描述名词数据层文件命名 数据库名称编程规范代码注释原则上平均每100行代码中要有203

6、0行注释，视程序复杂程度而定。所有注释应使用中文。例如:/添加一个用户函数关于源文件和类，必须在注释中讲明修改历史具体规范参见项目根目录下的CodingSample.cs类和接口的注释在中填写类的简要描述，中填写类的一些注意事项。Histroy填写修改记录。所有类和接口都要注释。类的操作注释由详细设计产物导出，编程人员补充完成从Title到History的部分。例如：/ / 接口定义了实体类的增、删、改、读 / （CRUD）方法，该接口的实现类将负责用户对象的简单治理。 / / / 接口仅定义实体对象的CRUD操作方法， / 并没有定义关联用户对象与群组、组织机构等的操作，这些业务逻辑操作的方

7、法定义在/ 专门的关联操作接口及中。 / / Title: IUserManager / Copyright: * Software LTD.co Copyright (c) 2006 / Company: *有限公司/ Designer: */ Coder: 姜辉/ Reviewer: / Tester: * / Version: 1.0 / History:/2006-07-14 任维 创建/2006-07-15 任维 编码/ 2006-08-10 任维修改 依照外部用户需要,包装GetUserNameById()WEB服务方法.类成员变量的注释类成员变量的注释如下例所示：/ / 用户的名

8、称/ public string username;在声明前，利用.Net的格式来注释，原则上类的成员变量都要注释。方法的注释/ / 依照指定的用户登录名、姓名及密码创建（注册）一个新用户（）。 / / / 当满足如下任意情形之一时，创建用户的操作将会失败： / 1，指定的用户名在用户持久化存储中已存在 / 2，指定的用户名不合法（空值，空字符串，多个空格，包含除字母及数字以外的非法字符，长度 / 超过64） / 3，指定的用户密码不合法（空值，空字符串，多个空格，包含除字母及数字以外的非法字符，长 / 度小于6位或大于位64） / 4，指定的用户姓名不合法（空值，空字符串，多个空格，长度大于

9、位64） / / 用户的登录名，该属性必须唯一，如“zhangsan” / 用户的名称，该属性能够重复，如多个用户均能够叫“张三” / 用户登录的密码 / 创建的新用户对象（） / 用户差不多存在时所抛出的异常 / 用户登录名不合法时所抛出的异常/exception / 用户姓名不合法时所抛出的异常 / 用户登录密码不合法时所抛出的异常中填写该方法的要紧功能描述，中填写该方法的注意事项，中填写方法的传入参数，以及各参数的意义。 填写函数返回值以及返回值的意义。注意在其中运用xml语法。所有的public及protected方法都要注释。程序中的注释在程序中，采纳 ”/”进行单行注释。所有程序中

10、的分支语句需要注释分支条件意义，循环语句需要注释循环的起始条件和中止条件。/ 满足支付条件if (MeetPayCondition() / 循环遍历数组for ( int i = 0; i =或者=进行比较通用规范推断与循环的注释关于大段的（超过20行）推断、循环语句，要加注释，关于推断语句（如if，switch），要讲明推断的条件和程序的走向。关于循环语句（如while,do while,for），要讲明循环接着和终止的条件。当有循环嵌套时,尽量把大循环放在内层.缩写规范一个项目中用到的同一词语的缩写要求完全统一，如”Project”缩写为”pjt”，则不准用其它的缩写，如”Prjt”或”P

11、jct”，同时区分大小写，即”PJT”也不能再用于表示”Project”。汉语拼音尽量不要使用汉语拼音的声母缩写来做命名。如”Py”用来表示”拼音”会有专门多的歧义。奇妙的数字不管用何种语言编程，都不要出现奇妙的数字，如下代码应视为违反本规范：int n;n = 128;关于程序中要用到的常数，在专门的文件中进行定义，定义方法统一用大写的英文，例如：public final int FILE_NAME_MAX_LENTH = 128;也能够写入到独立的配置文件中，在程序中读出其中的数值。假如仅仅是某个类中所使用的话，就作为常量写入类中，例如：private const string SIGN_

12、STATUS = “50”;关于数据类型为int型的这些常量，尽量使用枚举类型来处理这些奇妙数字。在程序中的数字也并不一定属于奇妙的数字，以下情况是同意的：索引数字，比如数组访问，数据库字段读取dataReader.GetString(2);单元测试代码中用到的数字。”的使用相关联的“和”要么处于同一行，要么处于同一列。只有一行的逻辑代码,能够省略常用命名前缀列表服务器控件命名(常用)控件类型名称前缀样例LabellbllblCurrentPageButtonbtnbtnAuditProjectTextBoxtxttxtDraftIdLinkButtonlbnlbnCreateDraftFor

13、mImageButtonibnibnCreateDraftFormHyperLinkhlkhlkPageLinkDropDownList*ddlddlDraftStatusCheckBoxchkchkCheckRadioButtonrbnrbnChoiceOneImageimgimgPictureHiddenFieldhidhidCreateDraftFormLiterallitlitDeviceGridWiewFileUploadfudfudChooseFilePanalpnlpnlEditHTML控件命名控件类型名称前缀样例spnspnMessagedivpnlInfotbtbDraftI

14、dtrtrCreateDraftFormtdtdCreateDraftFormahlkPageLinktxtddlDraftStatuschkcbxCheckrbnrbnGroupbtnimgPicturebtnhidCreateDraftFormibnlitDeviceGridWiewfudfudChooseFileddlpalEdittxt数据类型命名数据类型名称前缀样例stringstrspnMessageintint 或者 n pnlInfodecimaldectbDraftIdObjectobjsbytesb byte bt uint ui longlulongulfloatfdou

15、bledboolbdecimaldec 数据控件缩写规范数据类型名称前缀样例Connection conconNorthwind Command cmd cmdReturnProducts Parameter parm parmProductID DataAdapter dad dadProducts DataReader dtr dtrProducts DataSet dst dstNorthWind DataTable dtbl dtblProduct DataView dvw dvwFilteredProductsDataRelation drel drelMasterDetail DataColumn dcol dcolProductIDDataRow drow drowRow98 行业常用词命名规范公共及系统治理中文英文公司Company用户User登录Login手机Mobile电话Tel传真Fax配送Delivery联系人Contactor推举人Recommender配送Delivery支付Pay保险Insurance备注Remark政策Policy银行Bank银行帐号BankAccount航讯支付HXPay锁定Lock创建时刻CreateTime权限Right短消息SMS上级P