上海某公司绩效管理系统编程规范标准.doc

天强绩效管理系统编程规一 命名规1. 命名原则a. Pascal Casing属性每个单词的第一个字母大写，例如：BackColorb. Camel Casing 除了第一个单词以外的每个单词的第一个字母大写，例如：backColor.c. Upper Casing如果缩写字母的个数小于或等于2，那么所有的缩写字母都大写。3个以上的字母缩写采用Pascal Casing。例如：System.IO, System.Web.UI, System.CodeDom。2. 类的命名a. 用Pascal Casing命名规则b. 谨慎的使用缩写c. 不要使用任何的前缀（例如：C_GetList）d. 不要使用下划线命名e. 已所拥有的功能作为描述命名3. 方法的命名a. 用Pascal Casing命名规则b. 谨慎的使用缩写c. 用动词或动词短语来命名（例如：public string GetAllList()）Data层的方法统一使用Insert()添加数据Update()修改数据GetModel()获取一条数据GetModelList()获取一个列表Delete()删除数据d. 不要使用下划线命名4. 属性的命名a. 用Pascal Casing命名规则b. 谨慎的使用缩写c. 用名词或名词短语来命名d. 不要使用下划线命名e. 可以考虑用类型名称作为属性名称（例如： public Color Color）5. 接口的命名a. 用Pascal Casing命名规则b. 谨慎的使用缩写c. 接口的前缀命名统一用I（方法本身的描述中有I开头的除外，例如：IGetPolicy）d. 不要使用下划线命名e. 接口名字用名词或者名词短语，或形容词来表述接口的行为6. 参数的命名a. 用Camel Casing命名规则b. 谨慎的使用缩写c. 由本地的参数类型+描述性单词（例如：objCompanyList, strName, nCode）d. 不要使用保留参数（Win32 API）e. 参数的名字应该是描述性的7. 变量的命名a. 用Camel Casing命名规则b. 避免无意义的变量命名（如：string a = string.Empty()，但 for(int i=0;i<5;i+)除外）c. 由本地的参数类型+描述性单词（例如：objCompanyList, strName, intCode）d. 不要使用保留参数（Win32 API）e. 参数的名字应该是描述性的8. 大小写敏感a. 不要出现两个只用大小写区分的命名空间b. 不要出现两个只用大小写区分的参数c. 不要出现两个只用大小写区分的同一命名空间的类型d. 不要出现两个只用大小写区分的同一类型属性e. 不要出现两个只用大小写区分的方法9. 类库的命名a. 要以系统的功能模块来划分类库，所有的类库的命名空间用KPI. 开头b. 用Pascal Casing命名规则c. 不要使用下划线命名d. 不能使用缩写e. 类库分为公共引用层，实体层，逻辑层和数据层类库f. 公共引用层命名 Commong. 实体层命名 KPI.Model，例如：KPI.Model.Syetemh. 逻辑层命名 KPI.Stategy. 例如：KPI.Stategy.Systemi. 数据层命名 KPI.Data. 例如：KPI.Data.System 10. 文件的命名a. 用Pascal Casing命名规则b. 公共引用层文件命名参考类的命名c. Web文件的命名 主要遵循 Pascal Casing命名规则d. 实体层文件命名分为 数据库实体，自定义实体, 条件实体。 e. 实体层数据库实体文件命名 数据库名称 + Model结尾命名f. 实体层自定义实体文件命名 功能描述名词 + Define结尾命名g. 实体层条件实体功能描述名词 + Condition结尾命名h. 逻辑层文件命名 功能描述名词i. 数据层文件命名 数据库名称二 编程规1. 代码注释原则上平均每100行代码中要有2030行注释，视程序复杂程度而定。所有注释应使用中文。例如:/添加一个用户函数对于源文件和类，必须在注释中说明修改历史具体规参见项目根目录下的CodingSample.cs2. 类和接口的注释在<summary>中填写类的简要描述，<remarks>中填写类的一些注意事项。Histroy填写修改记录。所有类和接口都要注释。类的操作注释由详细设计产物导出，编程人员补充完成从Title到History的部分。例如：/<summary>/<see cref="IUserManager"/>接口定义了<see cref="User"/>实体类的增、删、改、读/（CRUD）方法，该接口的实现类将负责用户对象的简单管理。/</summary>/<remarks>/<see cref="IUserManager"/>接口仅定义<see cref="User"/>实体对象的CRUD操作方法，/并没有定义关联用户对象与群组、组织机构等的操作，这些业务逻辑操作的方法定义在/专门的关联操作接口<see cref="IUserGroupAssociator"/>与<see cref="IUserOrgAssociator"/>中。/</remarks>/ 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服务方法.3. 类成员变量的注释类成员变量的注释如下例所示：/<summary>/用户的名称/</summary>publicstringusername;在声明前，利用.Net的格式来注释，原则上类的成员变量都要注释。4. 方法的注释/<summary>/根据指定的用户登录名、与密码创建（注册）一个新用户（<see cref="User"/>）。/</summary>/<remarks>/当满足如下任意情形之一时，创建用户的操作将会失败：/ 1，指定的用户名在用户持久化存储中已存在/ 2，指定的用户名不合法（空值，空字符串，多个空格，包含除字母与数字以外的非法字符，长度/超过64）/ 3，指定的用户密码不合法（空值，空字符串，多个空格，包含除字母与数字以外的非法字符，长/度小于6位或大于位64）/ 4，指定的用户不合法（空值，空字符串，多个空格，长度大于位64）/</remarks>/<param name="loginName">用户的登录名，该属性必须唯一，如“zhangsan”</param>/<param name="username">用户的名称，该属性可以重复，如多个用户均可以叫“三”</param>/<param name="password">用户登录的密码</param>/<returns>创建的新用户对象（<see cref="User"/>）</returns>/<exception cref="UserAlreadyExistsException">用户已经存在时所抛出的异常</exception>/<exception cref="InvalidLoginNameException">用户登录名不合法时所抛出的异常/exception>/<exception cref="InvalidUsernameException">用户不合法时所抛出的异常</exception>/<exception cref="InvalidPasswordException">用户登录密码不合法时所抛出的异常<exception><summary>中填写该方法的主要功能描述，<remarks>中填写该方法的注意事项，<param>中填写方法的传入参数，以与各参数的意义。<returns> 填写函数返回值以与返回值的意义。注意在其中运用xml语法。所有的public与protected方法都要注释。5. 程序中的注释在程序中，采用 ”/”进行单行注释。所有程序中的分支语句需要注释分支条件意义，循环语句需要注释循环的起始条件和中止条件。/ 满足支付条件if (MeetPayCondition()/循环遍历数组for ( int i = 0; i < Array.Count; i+ )6. 创建Model的规系统中所有要创建Model实体的地方必须是以下格式 obj实体名Model 格式。例如要创建一个User对象的实体UserModel objUserModel=new UserModel；objUserModel.UserName=”三”;7. 关于值的判断比较(1)布尔值布尔值的判断比较不允许直接与false或者true进行比较,更不能直接与0或者1进行比较,例如if(bFlag=0) 或者if(bFlag=false)应该遵循以下标准规则if(bFlag) 判断变量为真if(!bFlag) 判断变量为假(2)整形变量整形变量与0的比较应采用= 或者!= 严禁整形变量与0比较时采用布尔值的比较方式.(3)浮点型的变量严禁浮点型变量用=或者!=进行比较,浮点型的变量涉与到位数.正确做法是采用>=或者<=进行比较三 通用规1. 判断与循环的注释对于大段的（超过20行）判断、循环语句，要加注释，对于判断语句（如if，switch），要说明判断的条件和程序的走向。对于循环语句（如while,do while,for），要说明循环继续和终止的条件。当有循环嵌套时,尽量把大循环放在层.2. 缩写规一个项目中用到的同一词语的缩写要求完全统一，如”Project”缩写为”pjt”，则不准用其它的缩写，如”Prjt”或”Pjct”，并且区分大小写，即”PJT”也不能再用于表示”Project”。3. 汉语拼音尽量不要使用汉语拼音的声母缩写来做命名。如”Py”用来表示”拼音”会有很多的歧义。4. 神秘的数字无论用何种语言编程，都不要出现神秘的数字，如下代码应视为违反本规：int n;n = 128;对于程序中要用到的常数，在专门的文件中进行定义，定义方法统一用大写的英文，例如：public final int FILE_NAME_MAX_LENTH = 128;也可以写入到独立的配置文件中，在程序中读出其中的数值。如果仅仅是某个类中所使用的话，就作为常量写入类中，例如：private const string SIGN_STATUS = “50”;对于数据类型为int型的这些常量，尽量使用枚举类型来处理这些神秘数字。在程序中的数字也并不一定属于神秘的数字，以下情况是允许的：1， 索引数字，比如数组访问，数据库字段读取dataReader.GetString(2);2， 单元测试代码中用到的数字。5. ”的使用相关联的“和”要么处于同一行，要么处于同一列。只有一行的逻辑代码,可以省略四 常用命名前缀列表1. 服务器控件命名(常用)控件类型名称前缀样例LabellbllblCurrentPageButtonbtnbtnAuditProjectTextBoxtxttxtDraftIdLinkButtonlbnlbnCreateDraftFormImageButtonibnibnCreateDraftFormHyperLinkhlkhlkPageLinkDropDownList*ddlddlDraftStatusCheckBoxchkchkCheckRadioButtonrbnrbnChoiceOneImageimgimgPictureHiddenFieldhidhidCreateDraftFormLiterallitlitDeviceGridWiewFileUploadfudfudChooseFilePanalpnlpnlEdit2. HTML控件命名控件类型名称前缀样例<span>spnspnMessage<div>divpnlInfo<table>tbtbDraftId<tr>trtrCreateDraftForm<td>tdtdCreateDraftForm<a>ahlkPageLink<input type=text>txtddlDraftStatus<input type=checkbox>chkcbxCheck<input type=radio>rbnrbnGroup<input type=button>btnimgPicture<input type=submit>btnhidCreateDraftForm<input type=image>ibnlitDeviceGridWiew<input type=file>fudfudChooseFile<select>ddlpalEdit<textarea>txt3. 数据类型命名数据类型名称前缀样例stringstrspnMessageintint 或者 n pnlInfodecimaldectbDraftIdObjectobjsbytesb byte bt uint ui longlulongulfloatfdoubledboolbdecimaldec 数据控件缩写规数据类型名称前缀样例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 4. 行业常用词命名规4.1 公共与系统管理中文英文公司Company用户User登录Login手机MobileTelFax配送Delivery联系人Contactor推荐人Recommender配送Delivery支付Pay保险Insurance备注Remark政策Policy银行Bank银行BankAccount航讯支付HXPay锁定Lock创建时间CreateTime权限Right短消息SMS上级Parent下级Child上级公司ParentCompany下级公司ChildCompany上级返款ParentFare下级返点ChildDiscount下级返款ChildFare利润Profit实发工资NetPay4.2 业务逻辑管理中文英文考核Assessment绩效Performance指标Indicators4.3 帐务管理中文英文账单Bill账户Account授信Credit押金Deposit审核Auditing申请Apply统计Static4.4 系统管理中文英文部门Departments岗位Position9 / 9