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

《天强绩效考核系统开发命名规范34748.docx》由会员分享，可在线阅读，更多相关《天强绩效考核系统开发命名规范34748.docx（19页珍藏版）》请在淘文阁 - 分享文档赚钱的网站上搜索。

1、天强绩效管理系统编程规范一 命名规范1. 命名原则a. Pascaal CCasiing属性每个单单词的第第一个字字母大写写，例如如：BaackCColoorb. Camell Caasinng 除了第一个个单词以以外的每每个单词词的第一一个字母母大写，例例如：bbackkCollor.c. Upperr Caasinng如果缩写字字母的个个数小于于或等于于2，那么么所有的的缩写字字母都大大写。33个以上上的字母母缩写采用PPasccal Cassingg。例如如：Syysteem.IIO, Sysstemm.Weeb.UUI, Systeem.CCodeeDomm。2. 类的命名a. 用Pa

2、sccal Cassingg命名规规则b. 谨慎的使用用缩写c. 不要使用任任何的前前缀（例例如：CC_GeetLiist）d. 不要使用下下划线命命名e. 已所拥有的的功能作作为描述述命名3. 方法的命名名a. 用Pasccal Cassingg命名规规则b. 谨慎的使用用缩写c. 用动词或动动词短语语来命名名（例如如：puubliic sstriing GettAlllLisst()）Data层层的方法法统一使使用Inserrt()添加数据Updatte()修改数据GetMoodell()获取一条数数据GetMoodellLisst()获取一个列列表Delette()删除数据d. 不要使用

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

4、 用Cameel CCasiing命命名规则则b. 谨慎的使用用缩写c. 由本地的参参数类型型+描述述性单词词（例如如：obbjCoompaanyLListt, sstrNNamee, nnCodde）d. 不要使用保保留参数数（Wiin322 APPI）e. 参数的名字字应该是是描述性性的7. 变量的命名名a. 用Cameel CCasiing命命名规则则b. 避免无意义义的变量量命名（如如：sttrinng aa = strringg.Emmptyy()，但但 foor(iint i=00;i5;ii+)除外）c. 由本地的参参数类型型+描述述性单词词（例如如：obbjCoompaanyL

5、Listt, sstrNNamee, iintCCodee）d. 不要使用保保留参数数（Wiin322 APPI）e. 参数的名字字应该是是描述性性的8. 大小写敏感感a. 不要出现两两个只用用大小写写区分的的命名空空间b. 不要出现两两个只用用大小写写区分的的参数c. 不要出现两两个只用用大小写写区分的的同一命命名空间间的类型型d. 不要出现两两个只用用大小写写区分的的同一类类型属性性e. 不要出现两两个只用用大小写写区分的的方法9. 类库的命名名a. 要以系统的的功能模模块来划划分类库库，所有有的类库库的命名名空间用用KPII. 开开头b. 用Pasccal Cassingg命名规规则c.

6、 不要使用下下划线命命名d. 不能使用缩缩写e. 类库分为公公共引用用层，实实体层，逻逻辑层和和数据层层类库f. 公共引用层层命名 Commmonng. 实体层命名名 KPPI.Moddel，例例如：KKPI.Moddel.Syeetemmh. 逻辑层命名名 KPPI.SStattegyy.例如如：KPPI.SStattegyy.Syysteemi. 数据层命名名 KPPI.DDataa.例如如：KPPI.DDataa.Syysteem10. 文件的命名名a. 用Pasccal Cassingg命名规规则b. 公共引用层层文件命命名参考考类的命命名c. Web网站站内文件件的命名名 主要要遵循

7、 Passcall Caasinng命名名规则d. 实体层文件件命名分分为 数数据库实实体，自自定义实实体, 条件实实体。 e. 实体层数据据库实体体文件命命名 数数据库名名称 + Moodell结尾命命名f. 实体层自定定义实体体文件命命名 功功能描述述名词 + DDefiine结结尾命名名g. 实体层条件件实体功功能描述述名词 + CCondditiion结结尾命名名h. 逻辑层文件件命名 功能描描述名词词i. 数据层文件件命名 数据库库名称二 编程规范1. 代码注释原则上平均均每1000行代代码中要要有200300行注释释，视程程序复杂杂程度而而定。所有注释应应使用中中文。例例如:/添加

8、加一个用用户函数数对于源文件件和类，必必须在注注释中说说明修改改历史具体规范参参见项目目根目录录下的CCodiingSSampple.cs2. 类和接口的的注释在中中填写类类的简要要描述，中中填写类类的一些些注意事事项。HHisttroyy填写修修改记录录。所有类和接接口都要要注释。类类的操作作注释由由详细设设计产物物导出，编编程人员员补充完完成从TTitlle到HHisttoryy的部分分。例如：/接口定定义了实实体类的的增、删删、改、读读/（CCRUDD）方法法，该接接口的实实现类将将负责用用户对象象的简单单管理。/接口仅仅定义实实体对象象的CRRUD操操作方法法，/并没没有定义义关联用用

9、户对象象与群组组、组织织机构等等的操作作，这些些业务逻逻辑操作作的方法法定义在在/专门门的关联联操作接接口及及中中。/ TTitlle: IUsserMManaagerr/ CCopyyrigght: * SSofttwarre LLTD.co Coppyriightt (cc) 220066/ CComppanyy: *有限限公司/Deesiggnerr: */Cooderr: 姜辉辉/Reevieewerr: /Teesteer: */Veersiion: 1.0/ HHisttoryy:/20006-07-114 任维 创建建/20006-07-115 任维维 编编码/ 20006-00

10、8-110 任任维修修改 根据外外部用户户需要,包装GGetUUserrNammeByyId()WEEB服务务方法.3. 类成员变量量的注释释类成员变量量的注释释如下例例所示：/用户户的名称称/publiicsttrinngussernnamee;在声明前，利利用.NNet的的格式来来注释，原原则上类类的成员员变量都都要注释释。4. 方法的注释释/根据据指定的的用户登登录名、姓姓名及密密码创建建（注册册）一个个新用户户（）。/当满满足如下下任意情情形之一一时，创创建用户户的操作作将会失失败：/ 11，指定定的用户户名在用用户持久久化存储储中已存存在/ 22，指定定的用户户名不合合法（空空值，空

11、空字符串串，多个个空格，包包含除字字母及数数字以外外的非法法字符，长长度/超过过64）/ 33，指定定的用户户密码不不合法（空空值，空空字符串串，多个个空格，包包含除字字母及数数字以外外的非法法字符，长长/度小小于6位位或大于于位644）/ 44，指定定的用户户姓名不不合法（空空值，空空字符串串，多个个空格，长长度大于于位644）/用户户的登录录名，该该属性必必须唯一一，如“zhaangssan”/用户的的名称，该该属性可可以重复复，如多多个用户户均可以以叫“张三”/用户登登录的密密码/创建建的新用用户对象象（）/用户户已经存存在时所所抛出的的异常/用户登登录名不不合法时时所抛出出的异常常/e

12、xxcepptioon/用用户姓名名不合法法时所抛抛出的异异常/用用户登录录密码不不合法时时所抛出出的异常常中填填写该方方法的主主要功能能描述，中中填写该该方法的的注意事事项，中填写写方法的的传入参参数，以以及各参参数的意意义。 填写函函数返回回值以及及返回值值的意义义。注意意在其中中运用xxml语语法。所所有的ppubllic及及prootecctedd方法都都要注释释。5. 程序中的注注释在程序中，采采用 ”/”进行单单行注释释。所有程序中中的分支支语句需需要注释释分支条条件意义义，循环环语句需需要注释释循环的的起始条条件和中中止条件件。/ 满足足支付条条件if (MMeettPayyCo

13、nndittionn()/循环遍遍历数组组for ( innt ii = 0; i =或或者=进行比比较三 通用规范1. 判断与循环环的注释释对于大段的的（超过过20行行）判断断、循环环语句，要要加注释释，对于于判断语语句（如如if，sswittch），要要说明判判断的条条件和程程序的走走向。对对于循环环语句（如如whiile,do whiile,forr），要要说明循循环继续续和终止止的条件件。当有循环嵌嵌套时,尽量把把大循环环放在内内层.2. 缩写规范一个项目中中用到的的同一词词语的缩缩写要求求完全统统一，如如”Proojecct”缩写为为”pjtt”，则不不准用其其它的缩缩写，如如”Pr

14、jjt”或”Pjcct”，并且且区分大大小写，即即”PJTT”也不能能再用于于表示”Proojecct”。3. 汉语拼音尽量不要使使用汉语语拼音的的声母缩缩写来做做命名。如如”Py”用来表表示”拼音”会有很很多的歧歧义。4. 神秘的数字字无论用何种种语言编编程，都都不要出出现神秘秘的数字字，如下下代码应应视为违违反本规规范：int nn;n = 1128;对于程序中中要用到到的常数数，在专专门的文文件中进进行定义义，定义义方法统统一用大大写的英英文，例例如：publiic ffinaal iint FILLE_NNAMEE_MAAX_LLENTTH = 1228;也可以写入入到独立立的配置置文

15、件中中，在程程序中读读出其中中的数值值。如果仅仅是是某个类类中所使使用的话话，就作作为常量量写入类类中，例例如：privaate connst strringg SIIGN_STAATUSS = “500”;对于数据类类型为iint型型的这些些常量，尽尽量使用用枚举类类型来处处理这些些神秘数数字。在程序中的的数字也也并不一一定属于于神秘的的数字，以以下情况况是允许许的：1， 索引数字，比比如数组组访问，数数据库字字段读取取dattaReeadeer.GGetSStriing(2);2， 单元测试代代码中用用到的数数字。5. ”的的使用相关联的“和”要么处处于同一一行，要要么处于于同一列列。只有

16、有一行的的逻辑代代码,可可以省略略四 常用命名前前缀列表表1. 服务器控件件命名(常用)控件类型名称前缀样例LabelllbllblCuurreentPPageeButtoonbtnbtnAuudittProojecctTextBBoxtxttxtDrrafttIdLinkBButttonlbnlbnCrreatteDrrafttForrmImageeButttonnibnibnCrreatteDrrafttForrmHyperrLinnkhlkhlkPaageLLinkkDropDDownnLisst*ddlddlDrrafttStaatussCheckkBoxxchkchkChheckkR

17、adiooButttonnrbnrbnChhoicceOnneImageeimgimgPiictuureHiddeenFiielddhidhidCrreatteDrrafttForrmLiterrallitlitDeevicceGrridWWiewwFileUUplooadfudfudChhoosseFiilePanallpnlpnlEddit2. HTML控控件命名名控件类型名称前缀样例spnspnMeessaagedivpnlInnfotbtbDraaftIIdtrtrCreeateeDraaftFFormmtdtdCreeateeDraaftFFormmahlkPaageLLinkktx

18、tddlDrrafttStaatusschkcbxChheckkrbnrbnGrrouppbtnimgPiictuurebtnhidCrreatteDrrafttForrmibnlitDeevicceGrridWWiewwfudfudChhoosseFiileddlpalEddittxt3. 数据类型命命名数据类型名称前缀样例strinngstrspnMeessaageintint 或或者 nn pnlInnfodecimmaldectbDraaftIIdObjecctobjsbyteesb byte bt uint ui longlulonggulfloattfdoublledboolbde

19、cimmaldec 数据据控件缩缩写规范范数据类型名称前缀样例Conneectiion conconNoorthhwinnd Commaand cmd cmdReeturrnPrroduuctss Parammeteer parm parmPProdducttID DataAAdappterr dad dadPrroduuctss DataRReadder dtr dtrPrroduuctss DataSSet dst dstNoorthhWinnd DataTTablle dtbl dtblPProdductt DataVVieww dvw dvwFiilteereddProoducctsD

20、ataRRelaatioon drel drelMMastterDDetaail DataCColuumn dcol dcolPProdducttIDDataRRow drow drowRRow998 4. 行业常用词词命名规规范4.1 公共及系统统管理中文英文公司Compaany用户User登录Loginn手机Mobille电话Tel传真Fax配送Delivveryy联系人Contaactoor推荐人Recommmennderr配送Delivveryy支付Pay保险Insurrancce备注Remarrk政策Policcy银行Bank银行帐号BankAAccoountt航讯支付HXPayy锁

21、定Lock创建时间CreatteTiime权限Rightt短消息SMS上级Parennt下级Childd上级公司ParenntCoompaany下级公司ChilddCommpanny上级返款ParenntFaare下级返点ChilddDisscouunt下级返款ChilddFarre利润Profiit实发工资NetPaay4.2 业务逻辑管管理中文英文考核Assesssmeent绩效Perfoormaancee指标Indiccatoors4.3 帐务管理中文英文账单Bill账户Accouunt授信Crediit押金Depossit审核Audittingg申请Applyy统计Statiic4.4 系统管理中文英文部门Deparrtmeentss岗位Posittionn