上海某公司绩效管理系统编程规范27158.docx

《上海某公司绩效管理系统编程规范27158.docx》由会员分享，可在线阅读，更多相关《上海某公司绩效管理系统编程规范27158.docx（14页珍藏版）》请在淘文阁 - 分享文档赚钱的网站上搜索。

1、 天强绩效管管理系统编程规范一 命名规范1. 命名原则a. Pascaal Caasingg属性每个单单词的第一一个字母大大写，例如如：BacckCollorb. Camell Cassing 除了第一个个单词以外外的每个单单词的第一一个字母大大写，例如如：backkColoor.c. Upperr Cassing如果缩写字字母的个数数小于或等等于2，那么所所有的缩写写字母都大大写。3个以上的的字母缩写采用PPascaal Caasingg。例如：Systtem.IIO, SSysteem.Weeb.UII, Systeem.CoodeDoom。2. 类的命名a. 用Pasccal CCasi

2、nng 命名规则则b. 谨慎的使用用缩写c. 不要使用任任何的前缀缀（例如：C_GeetLisst）d. 不要使用下下划线命名名e. 已所拥有的的功能作为为描述命名名3. 方法的命名名a. 用Passcal Casiing 命名规则则b. 谨慎的使用用缩写c. 用动词或动动词短语来来命名（例例如：publlic sstrinng GeetAlllListt()）Data层层的方法统统一使用Inserrt()添加数据Updatte()修改数据GetMoodel()获取一条数数据GetMoodelLList()获取一个列列表Delette()删除数据d. 不要使用下下划线命名名4. 属性的命名名a

3、. 用Passcal Casiing 命名规则则b. 谨慎的使用用缩写c. 用名词或名名词短语来来命名d. 不要使用下下划线命名名e. 可以考虑用用类型名称称作为属性性名称（例例如： pubblic Coloor Coolor）5. 接口的命名名a. 用Pasccal CCasinng 命名规则则b. 谨慎的使用用缩写c. 接口的前缀缀命名统一一用I（方法本本身的描述述中有I开头的除除外，例如如：IGettPoliicy）d. 不要使用下下划线命名名e. 接口名字用用名词或者者名词短语语，或形容容词来表述述接口的行行为6. 参数的命名名a. 用Cameel Caasingg 命名规则则b. 谨

4、慎的使用用缩写c. 由本地的参参数类型+描述性单单词（例如如：objCCompaanyLiist, strNName, nCoode）d. 不要使用保保留参数（Win332 APPI）e. 参数的名字字应该是描描述性的7. 变量的命名名a. 用Cameel Caasingg 命名规则则b. 避免无意义义的变量命命名（如：striing aa = sstrinng.Emmpty()，但 forr(intt i=00;i55;i+)除外）c. 由本地的参参数类型+描述性单单词（例如如：objCCompaanyLiist, strNName, inttCodee）d. 不要使用保保留参数（Win32

5、2 APII）e. 参数的名字字应该是描描述性的8. 大小写敏感感a. 不要出现两两个只用大大小写区分分的命名空空间b. 不要出现两两个只用大大小写区分分的参数c. 不要出现两两个只用大大小写区分分的同一命命名空间的的类型d. 不要出现两两个只用大大小写区分分的同一类类型属性e. 不要出现两两个只用大大小写区分分的方法9. 类库的命名名a. 要以系统的的功能模块块来划分类类库，所有有的类库的的命名空间间用KPI. 开头b. 用Pasccal CCasinng 命名规则则c. 不要使用下下划线命名名d. 不能使用缩缩写e. 类库分为公公共引用层层，实体层层，逻辑层层和数据层层类库f. 公共引用层

6、层命名 Commmong. 实体层命名名 KPII.Moddel，例如：KPI.Modeel.Syyetemmh. 逻辑层命名名 KPII.Staategyy. 例如：KPI.Stattegy.Systtemi. 数据层命名名 KPII.Datta. 例如：KPI.Dataa.Sysstem 10. 文件的命名名a. 用Pasccal CCasinng 命名规则则b. 公共引用层层文件命名名参考类的的命名c. Web网站站内文件的的命名 主要遵循 Pasccal CCasinng 命名规则则d. 实体层文件件命名分为为 数据库实实体，自定定义实体, 条件实体体。 e. 实体层数据据库实体文文件

7、命名 数据库名名称 + MModell结尾命名名f. 实体层自定定义实体文文件命名 功能描述名名词 + DDefinne结尾命名名g. 实体层条件件实体功能能描述名词词 + CCondiitionn结尾命名名h. 逻辑层文件件命名 功能描述述名词i. 数据层文件件命名 数据库名名称二 编程规范1. 代码注释原则上平均均每100行代码中中要有2030行注释，视视程序复杂杂程度而定定。所有注释应应使用中文文。例如:/添加一个个用户函数数对于源文件件和类，必必须在注释释中说明修修改历史具体规范参参见项目根根目录下的的CodiingSaamplee.cs2. 类和接口的的注释在中填写类类的简要描描述，

8、中填写类类的一些注注意事项。Histtroy填写修改记录。所有类和接接口都要注注释。类的的操作注释释由详细设设计产物导导出，编程程人员补充充完成从Titlle到Histtory的部分。例如：/ / 接口口定义了实体类类的增、删删、改、读读 / （CRUDD）方法，该该接口的实实现类将负负责用户对对象的简单单管理。 / / / 接口口仅定义实体对对象的CRRUD操作作方法， / 并没有定定义关联用用户对象与与群组、组组织机构等等的操作，这这些业务逻逻辑操作的的方法定义义在/ 专专门的关联联操作接口口及中。 / / TTitlee: IUUserMManagger / CCopyrrightt:

9、* Sooftwaare LLTD.cco Coopyriight (c) 20066 / CCompaany: *有限公公司/ DDesiggner: */ CCoderr: 姜辉/ RRevieewer: / TTesteer: * / Versiion: 1.0 / HHistoory:/20066-07-144 任维 创建/20066-07-15 任维 编码/ 22006-08-110 任维修改 根据外部部用户需要要,包装GetUUserNNameBById()WEBB服务方法.3. 类成员变量量的注释类成员变量量的注释如如下例所示示：/ / 用户的名名称/ publlic strii

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

11、于于位64） / 44，指定的的用户姓名名不合法（空值，空字符串，多个空格，长度大于位64） / / 用户的登登录名，该该属性必须须唯一，如如“zhanngsann” / 用用户的名称称，该属性性可以重复复，如多个个用户均可可以叫“张三” / 用用户登录的的密码 / 创建的的新用户对对象（） / 用户已已经存在时时所抛出的的异常 / 用户登录录名不合法法时所抛出出的异常/exceeptioon / 用户户姓名不合合法时所抛抛出的异常常 / 用用户登录密密码不合法法时所抛出出的异常中填写该该方法的主主要功能描描述，中填写该该方法的注注意事项，中填写方方法的传入入参数，以以及各参数数的意义。 填写

12、函数数返回值以以及返回值值的意义。注注意在其中中运用xml语法。所所有的publlic及proteectedd方法都要要注释。5. 程序中的注注释在程序中，采采用 ”/”进行单行行注释。所有程序中中的分支语语句需要注注释分支条条件意义，循循环语句需需要注释循循环的起始始条件和中中止条件。/ 满足足支付条件件if (MMeetPPayCoondittion() / 循环环遍历数组组for ( intt i = 0; i =或者=进行比较较三 通用规范1. 判断与循环环的注释对于大段的的（超过20行）判断断、循环语语句，要加加注释，对对于判断语语句（如if，swittch），要说说明判断的的条件和

13、程程序的走向向。对于循循环语句（如while,do while,for），要说明循环继续和终止的条件。当有循环嵌嵌套时,尽量把大大循环放在在内层.2. 缩写规范一个项目中中用到的同同一词语的的缩写要求求完全统一一，如”Projject”缩写为”pjt”，则不准准用其它的的缩写，如如”Prjtt”或”Pjctt”，并且区区分大小写写，即”PJT”也不能再再用于表示示”Projject”。3. 汉语拼音尽量不要使使用汉语拼拼音的声母母缩写来做做命名。如如”Py”用来表示示”拼音”会有很多多的歧义。4. 神秘的数字字无论用何种种语言编程程，都不要要出现神秘秘的数字，如如下代码应应视为违反反本规范：i

14、nt nn;n = 1128;对于程序中中要用到的的常数，在在专门的文文件中进行行定义，定定义方法统统一用大写写的英文，例例如：publiic fiinal int FILEE_NAMME_MAAX_LEENTH = 1228;也可以写入入到独立的的配置文件件中，在程程序中读出出其中的数数值。如果仅仅是是某个类中中所使用的的话，就作作为常量写写入类中，例例如：privaate cconstt strring SIGNN_STAATUS = “50”;对于数据类类型为int型的这些些常量，尽尽量使用枚枚举类型来来处理这些些神秘数字字。在程序中的的数字也并并不一定属属于神秘的的数字，以以下情况是是

15、允许的：1， 索引数字，比比如数组访访问，数据据库字段读读取dataaReadder.GGetSttringg(2);2， 单元测试代代码中用到到的数字。5. ”的的使用相关联的“和”要么处于于同一行，要要么处于同同一列。只只有一行的的逻辑代码码,可以省略四 常用命名前前缀列表1. 服务器控件件命名(常用)控件类型名称前缀样例LabelllbllblCuurrenntPaggeButtoonbtnbtnAuuditPProjeectTextBBoxtxttxtDrraftIIdLinkBButtoonlbnlbnCrreateeDrafftForrmImageeButttonibnibnCrr

16、eateeDrafftForrmHyperrLinkkhlkhlkPaageLiinkDropDDownLList*ddlddlDrraftSStatuusCheckkBoxchkchkChheckRadiooButttonrbnrbnChhoiceeOneImageeimgimgPiicturreHiddeenFieeldhidhidCrreateeDrafftForrmLiterrallitlitDeeviceeGriddWiewwFileUUploaadfudfudChhooseeFileePanallpnlpnlEddit2. HTML控控件命名控件类型名称前缀样例spnspnMees

17、saggedivpnlInnfotbtbDraaftIddtrtrCreeateDDrafttFormmtdtdCreeateDDrafttFormmahlkPaageLiinktxtddlDrraftSStatuuschkcbxChheckrbnrbnGrroupbtnimgPiicturrebtnhidCrreateeDrafftForrmibnlitDeeviceeGriddWiewwfudfudChhooseeFileeddlpalEddittxt3. 数据类型命命名数据类型名称前缀样例strinngstrspnMeessaggeintint 或或者 n pnlInnfodecimma

18、ldectbDraaftIddObjecctobjsbyteesb byte bt uint ui longlulonggulfloattfdoublledboolbdecimmaldec 数据据控件缩写写规范数据类型名称前缀样例Conneectioon conconNoorthwwind Commaand cmd cmdReeturnnProdductss Parammeterr parm parmPProduuctIDD DataAAdaptter dad dadPrroduccts DataRReadeer dtr dtrPrroduccts DataSSet dst dstNoorth

19、WWind DataTTablee dtbl dtblPProduuct DataVView dvw dvwFiilterredPrroducctsDataRRelattion drel drelMMasteerDettail DataCColummn dcol dcolPProduuctIDDDataRRow drow drowRRow988 4. 行业常用词词命名规范范4.1 公共及系统统管理中文英文公司Compaany用户User登录Loginn手机Mobille电话Tel传真Fax配送Delivvery联系人Contaactorr推荐人Recommmendder配送Delivvery支

20、付Pay保险Insurrancee备注Remarrk政策Policcy银行Bank银行帐号BankAAccouunt航讯支付HXPayy锁定Lock创建时间CreatteTimme权限Rightt短消息SMS上级Parennt下级Childd上级公司ParenntCommpanyy下级公司ChilddComppany上级返款ParenntFarre下级返点ChilddDisccountt下级返款ChilddFaree利润Profiit实发工资NetPaay4.2 业务逻辑管管理中文英文考核Assesssmennt绩效Perfoormannce指标Indiccatorrs4.3 帐务管理中文英文账单Bill账户Accouunt授信Crediit押金Depossit审核Auditting申请Applyy统计Statiic4.4 系统管理中文英文部门Deparrtmennts岗位Posittion