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

天强绩效效管理系系统编程规范范一 命名规范范1. 命名原则则a. Pasccal Cassingg属性每个个单词的的第一个个字母大大写，例例如：BBackkCollorb. Cameel CCasiing 除了第一一个单词词以外的的每个单单词的第第一个字字母大写写，例如如：bacckCoolorr.c. Uppeer CCasiing如果缩写写字母的的个数小小于或等等于2，那么么所有的的缩写字字母都大大写。33个以上上的字母母缩写采用用Passcall Caasinng。例例如：SSysttem.IO, Syysteem.WWeb.UI, Systtem.CoddeDoom。2. 类的命名名a. 用Passcall Caasinng命名名规则b. 谨慎的使使用缩写写c. 不要使用用任何的的前缀（例如：C_GGetLListt）d. 不要使用用下划线线命名e. 已所拥有有的功能能作为描描述命名名3. 方法的命命名a. 用Passcall Caasinng命名名规则b. 谨慎的使使用缩写写c. 用动词或或动词短短语来命命名（例例如：pubblicc sttrinng GGetAAllLListt()）Dataa层的方方法统一一使用Inseert()添加数据据Updaate()修改数据据GetMModeel()获取一条条数据GetMModeelLiist()获取一个个列表Deleete()删除数据据d. 不要使用用下划线线命名4. 属性的命命名a. 用Passcall Caasinng命名名规则b. 谨慎的使使用缩写写c. 用名词或或名词短短语来命命名d. 不要使用用下划线线命名e. 可以考虑虑用类型型名称作作为属性性名称（例如： puubliic CColoor CColoor）5. 接口的命命名a. 用Passcall Caasinng命名名规则b. 谨慎的使使用缩写写c. 接口的前前缀命名名统一用用I（方法法本身的的描述中中有I开头的的除外，例如：IGeetPooliccy）d. 不要使用用下划线线命名e. 接口名字字用名词词或者名名词短语语，或形形容词来来表述接接口的行行为6. 参数的命命名a. 用Cammel Cassingg命名规规则b. 谨慎的使使用缩写写c. 由本地的的参数类类型+描述性性单词（例如：objjCommpannyLiist, sttrNaame, nCCodee）d. 不要使用用保留参参数（Winn32 APII）e. 参数的名名字应该该是描述述性的7. 变量的命命名a. 用Cammel Cassingg命名规规则b. 避免无意意义的变变量命名名（如：strringg a = sstriing.Emppty()，但 foor(iint i=00;i<<5;ii+)除外）c. 由本地的的参数类类型+描述性性单词（例如：objjCommpannyLiist, sttrNaame, inntCoode）d. 不要使用用保留参参数（Winn32 APII）e. 参数的名名字应该该是描述述性的8. 大小写敏敏感a. 不要出现现两个只只用大小小写区分分的命名名空间b. 不要出现现两个只只用大小小写区分分的参数数c. 不要出现现两个只只用大小小写区分分的同一一命名空空间的类类型d. 不要出现现两个只只用大小小写区分分的同一一类型属属性e. 不要出现现两个只只用大小小写区分分的方法法9. 类库的命命名a. 要以系统统的功能能模块来来划分类类库，所所有的类类库的命命名空间间用KPII.开头头b. 用Passcall Caasinng命名名规则c. 不要使用用下划线线命名d. 不能使用用缩写e. 类库分为为公共引引用层，实体层层，逻辑辑层和数数据层类类库f. 公共引用用层命名名 Coommoong. 实体层命命名 KPPI.MModeel，例如如：KPII.Moodell.Syyeteemh. 逻辑层命命名 KPPI.SStattegyy.例如如：KPII.Sttateegy.Sysstemmi. 数据层命命名 KPPI.DDataa.例如如：KPII.Daata.Sysstemm 10. 文件的命命名a. 用Passcall Caasinng命名名规则b. 公共引用用层文件件命名参参考类的的命名c. Web网网站内文文件的命命名主要遵遵循Passcall Caasinng命名名规则d. 实体层文文件命名名分为数据库库实体，自定义义实体,条件实实体。e. 实体层数数据库实实体文件件命名数据库库名称 + Moddel结尾命命名f. 实体层自自定义实实体文件件命名功能描描述名词 + Deffinee结尾命命名g. 实体层条条件实体体功能描描述名词词 + Conndittionn结尾命命名h. 逻辑层文文件命名名功能描描述名词词i. 数据层文文件命名名数据库库名称二 编程规范范1. 代码注释释原则上平平均每100行代码码中要有有2030行注释释，视程程序复杂杂程度而而定。所有注释释应使用用中文。例如:/添加一一个用户户函数对于源文文件和类类，必须须在注释释中说明明修改历历史具体规范范参见项项目根目目录下的的CoddinggSammplee.css2. 类和接口口的注释释在<suummaary>>中填写写类的简简要描述述，<reemarrks>>中填写写类的一一些注意意事项。Hisstrooy填写修改改记录。所有类和和接口都都要注释释。类的的操作注注释由详详细设计计产物导导出，编编程人员员补充完完成从Tittle到Hisstorry的部分分。例如：/<<summmarry>/<<seee crref="IUUserrMannageer"/>接口口定义了了<seee ccreff="UUserr"/>>实体类类的增、删、改改、读/（CRUUD）方方法，该该接口的的实现类类将负责责用户对对象的简简单管理理。/<</suummaary>>/<<remmarkks>/<<seee crref="IUUserrMannageer"/>接口口仅定义义<seee ccreff="UUserr"/>>实体对对象的CCRUDD操作方方法，/并并没有定定义关联联用户对对象与群群组、组组织机构构等的操操作，这这些业务务逻辑操操作的方方法定义义在/专专门的关关联操作作接口<<seee crref="IUUserrGrooupAAssoociaatorr"/>>及<seee ccreff="IIUseerOrrgAsssocciattor""/>中中。/<</reemarrks>>/ Tittle: IUUserrMannageer/ Coppyriightt: * SSofttwarre LLTD.co Coppyriightt (cc) 220066/ Commpanny: *有有限公司司/DDesiigneer: */CCodeer: 姜辉/RReviieweer: /TTestter: */VVerssionn: 11.0/ Hisstorry:/220066-07-114任维 创建建/220066-07-115任维 编码码/ 20006-08-10任任维修改根据外外部用户户需要,包装GettUseerNaameBByIdd()WWEB服务方法.3. 类成员变变量的注注释类成员变变量的注注释如下下例所示示：/<<summmarry>/用用户的名名称/<</suummaary>>publlicsstriinguuserrnamme;在声明前前，利用用.Neet的格式式来注释释，原则则上类的的成员变变量都要要注释。4. 方法的注注释/<<summmarry>/根根据指定定的用户户登录名名、姓名名及密码码创建（注册）一个新新用户（<seee ccreff="UUserr"/>>）。/<</suummaary>>/<<remmarkks>/当当满足如如下任意意情形之之一时，创建用用户的操操作将会会失败：/ 1，指指定的用用户名在在用户持持久化存存储中已已存在/ 2，指指定的用用户名不不合法（空值，空字符符串，多多个空格格，包含含除字母母及数字字以外的的非法字字符，长长度/超超过64）/ 3，指指定的用用户密码码不合法法（空值值，空字字符串，多个空空格，包包含除字字母及数数字以外外的非法法字符，长/度度小于6位或大大于位64）/ 4，指指定的用用户姓名名不合法法（空值值，空字字符串，多个空空格，长长度大于于位64）/<</reemarrks>>/<<parram namme=""logginNNamee">用用户的登登录名，该属性性必须唯唯一，如如“zhaangssan”</pparaam>/<<parram namme=""useernaame"">用户户的名称称，该属属性可以以重复，如多个个用户均均可以叫叫“张三”</pparaam>/<<parram namme=""passswoord"">用户户登录的的密码<</paaramm>/<<retturnns>创创建的新新用户对对象（<<seee crref="Usser""/>）</rretuurnss>/<<exccepttionn crref="UsserAAlreeadyyExiistssExccepttionn">用用户已经经存在时时所抛出出的异常常</eexceeptiion>>/<<exccepttionn crref="InnvallidLLogiinNaameEExceeptiion"">用户户登录名名不合法法时所抛抛出的异异常/eexceeptiion>>/<<exccepttionn crref="InnvallidUUserrnammeExxcepptioon">>用户姓姓名不合合法时所所抛出的的异常<</exxcepptioon>/<<exccepttionn crref="InnvallidPPasssworrdExxcepptioon">>用户登登录密码码不合法法时所抛抛出的异异常<exccepttionn><summmarry>中填写写该方法法的主要要功能描描述，<reemarrks>>中填写写该方法法的注意意事项，<paaramm>中填写写方法的的传入参参数，以以及各参参数的意意义。<reeturrns>>填写函函数返回回值以及及返回值值的意义义。注意意在其中中运用xml语法。所有的的pubblicc及prootecctedd方法都都要注释释。5. 程序中的的注释在程序中中，采用用”/”进行单单行注释释。所有程序序中的分分支语句句需要注注释分支支条件意意义，循循环语句句需要注注释循环环的起始始条件和和中止条条件。/ 满满足支付付条件if (MeeetPaayCoondiitioon()/循环环遍历数数组for ( iint i = 0; i < AArraay.CCounnt; i+ )6. 创建Moodell的规范范系统中所所有要创创建Moddel实体的的地方必必须是以以下格式式 obbj实体名Moddel格格式。例如要创创建一个个Useer对象的的实体UserrModdelobjjUseerMoodell=neew UUserrModdel；objUUserrModdel.UseerNaame=”张三”;7. 关于值的的判断比比较(1)布布尔值布尔值的的判断比比较不允允许直接接与fallse或者truue进行比比较,更不能能直接与与0或者1进行比比较,例如if(bFllag=0) 或者if(bFllag=faalsee)应该遵循循以下标标准规则则if(bbFlaag) 判断变变量为真真if(!bFllag) 判断断变量为为假(2)整整形变量量整形变量量与0的比较较应采用用=或者!=严禁禁整形变变量与0比较时时采用布布尔值的的比较方方式.(3)浮浮点型的的变量严禁浮点点型变量量用=或者!=进行比比较,浮点型型的变量量涉及到到位数.正确做做法是采采用>=或者<=进行比比较三 通用规范范1. 判断与循循环的注注释对于大段段的（超超过20行）判判断、循循环语句句，要加加注释，对于判判断语句句（如if，swiitchh），要要说明判判断的条条件和程程序的走走向。对对于循环环语句（如whiile,do whiile,forr），要要说明循循环继续续和终止止的条件件。当有循环环嵌套时时,尽量把把大循环环放在内内层.2. 缩写规范范一个项目目中用到到的同一一词语的的缩写要要求完全全统一，如”Proojecct”缩写为为”pjtt”，则不不准用其其它的缩缩写，如如”Prjjt”或”Pjcct”，并且且区分大大小写，即”PJT”也不能能再用于于表示”Proojecct”。3. 汉语拼音音尽量不要要使用汉汉语拼音音的声母母缩写来来做命名名。如”Py”用来表表示”拼音”会有很很多的歧歧义。4. 神秘的数数字无论用何何种语言言编程，都不要要出现神神秘的数数字，如如下代码码应视为为违反本本规范：int n;n = 1288;对于程序序中要用用到的常常数，在在专门的的文件中中进行定定义，定定义方法法统一用用大写的的英文，例如：publlic finnal intt FIILE_NAMME_MMAX_LENNTH = 1128;也可以写写入到独独立的配配置文件件中，在在程序中中读出其其中的数数值。如果仅仅仅是某个个类中所所使用的的话，就就作为常常量写入入类中，例如：privvatee coonstt sttrinng SSIGNN_STTATUUS =“50”;对于数据据类型为为int型的这这些常量量，尽量量使用枚枚举类型型来处理理这些神神秘数字字。在程序中中的数字字也并不不一定属属于神秘秘的数字字，以下下情况是是允许的的：1， 索引数字字，比如如数组访访问，数数据库字字段读取取dattaReeadeer.GGetSStriing(2);2， 单元测试试代码中中用到的的数字。5. ”的使用用相关联的的“和”要么处处于同一一行，要要么处于于同一列列。只有有一行的的逻辑代代码,可以省省略四 常用命名名前缀列列表1. 服务器控控件命名名(常用)控件类型型名称前缀缀样例LabeellbllblCCurrrenttPaggeButttonbtnbtnAAudiitPrrojeectTexttBoxxtxttxtDDrafftIddLinkkButttonnlbnlbnCCreaateDDrafftFoormImaggeBuuttoonibnibnCCreaateDDrafftFoormHypeerLiinkhlkhlkPPageeLinnkDroppDowwnLiist*ddlddlDDrafftSttatuusChecckBooxchkchkCChecckRadiioBuuttoonrbnrbnCChoiiceOOneImaggeimgimgPPicttureeHidddenFFielldhidhidCCreaateDDrafftFoormLiteeralllitlitDDeviiceGGriddWieewFileeUplloaddfudfudCChoooseFFileePanaalpnlpnlEEditt2. HTMLL控件命命名控件类型型名称前缀缀样例<spaan>spnspnMMesssagee<divv>divpnlIInfoo<tabble>>tbtbDrrafttId<tr>>trtrCrreatteDrrafttForrm<td>>tdtdCrreatteDrrafttForrm<a>ahlkPPageeLinnk<inpput typpe=texxt>txtddlDDrafftSttatuus<inpput typpe=cheeckbbox>chkcbxCChecck<inpput typpe=raddio>rbnrbnGGrouup<inpput typpe=butttonn>btnimgPPictturee<inpput typpe=subbmitt>btnhidCCreaateDDrafftFoorm<inpput typpe=imaage>ibnlitDDeviiceGGriddWieew<inpput typpe=fille>fudfudCChoooseFFilee<sellectt>ddlpalEEditt<texxtarrea>>txt3. 数据类型型命名数据类型型名称前缀缀样例striingstrspnMMesssageeintint或或者 n pnlIInfoodeciimalldectbDrrafttIdObjeectobjsbyttesbbytee bt uintt ui longglulonngulfloaatfdoubbledboollbdeciimalldec数据控件件缩写规规范数据类型型名称前缀缀样例Connnecttionn conconNNortthwiind Commmandd cmd cmdRRetuurnPProdductts Paraametter parmm parmmProoducctIDD DataaAdaapteer dad dadPProdductts DataaReaaderr dtr dtrPProdductts DataaSett dst dstNNortthWiind DataaTabble dtbll dtbllProoducct DataaVieew dvw dvwFFilttereedPrroduuctssDataaRellatiion drell drellMassterrDettaill DataaCollumnn dcoll dcollProoducctIDDDataaRoww droww drowwRoww98 4. 行业常用用词命名名规范4.1 公共及系系统管理理中文英文公司Comppanyy用户Userr登录Logiin手机Mobiile电话Tel传真Fax配送Deliiverry联系人Conttacttor推荐人Recoommeendeer配送Deliiverry支付Pay保险Insuurannce备注Remaark政策Poliicy银行Bankk银行帐号号BankkAcccounnt航讯支付付HXPaay锁定Lockk创建时间间CreaateTTimee权限Righht短消息SMS上级Pareent下级Chilld上级公司司PareentCComppanyy下级公司司ChilldCoompaany上级返款款PareentFFaree下级返点点ChilldDiiscoountt下级返款款ChilldFaare利润Proffit实发工资资NetPPay4.2 业务逻辑辑管理中文英文考核Asseessmmentt绩效Perfformmancce指标Indiicattorss4.3 帐务管理理中文英文账单Billl账户Accoountt授信Creddit押金Depoositt审核Audiitinng申请Applly统计Stattic4.4 系统管理理中文英文部门Depaartmmentts岗位Posiitioon