命名规范 (详解)
- 格式:pdf
- 大小:200.91 KB
- 文档页数:17
1、版本命名规范软件版本号有四部分组成,第一部分为主版本号,第二部分为次版本号,第三部分为修订版本号,第四部分为日期版本号加希腊字母版本号,希腊字母版本号共有五种,分别为base、alpha、beta 、RC 、release。
2、软件版本阶段说明Base:此版本表示该软件仅仅是一个基础功能,通常包括所有将要编写的功能,但是功能都没有做完整的实现,只是做为软件整体的一个基础架构。
Alpha:软件的初级版本,表示该软件在此阶段以实现软件功能为主,通常只在软件开发者内部交流,一般而言,该版本软件的Bug较多,需要继续修改,是测试版本。
测试人员提交Bug经开发人员修改确认之后,发布到测试xx让测试人员测试,此时可将软件版本标注为alpha版。
Beta:该版本相对于Alpha 版已经有了很大的进步,消除了严重错误,但还需要经过多次测试来进一步消除,此版本主要的修改对象是软件的UI。
修改的的Bug 经测试人员测试确认后可发布到外网上,此时可将软件版本标注为beta版。
RC:该版本已经相当成熟了,基本上不存在导致错误的Bug,与即将发行的正式版本相差无几。
Release:该版本意味“最终版本”,在前面版本的一系列测试版之后,终归会有一个正式的版本,是最终交付用户使用的一个版本。
该版本有时也称标准版。
3、版本号修改规则(1)主版本号:当功能模块有较大的变动,比如增加模块或是整体架构发生变化。
此版本号由项目决定是否修改。
(2)次版本号:相对于主版本号而言,次版本号的升级对应的只是局部的变动,但该局部的变动造成程序和以前版本不能兼容,或者对该程序以前的协作关系产生了破坏,或者是功能上有大的改进或增强。
此版本号由项目决定是否修改。
(3)修订版本号:一般是Bug 的修复或是一些小的变动或是一些功能的扩充,要经常发布修订版,修复一个严重Bug 即可发布一个修订版。
此版本号由项目经理决定是否修改。
(4)日期版本号:用于记录修改项目的当前日期,每天对项目的修改都需要更改日期版本号。
一、骆驼命名法:骆驼式命令法,正如它的名称所表示的那样,是指混合使用大小写字母来构成变量和函数的名字。
形如:printEmployeePaychecks();print_employee_paychecks();注意:下划线法是c出现后开始流行起来的,在许多旧的程序和UNIX这样的环境中,它的使用非常普遍,另它也用于定义系统的函数库和Microsoft Windows这样的环境中,不建议使用。
二、帕斯卡(pascal)命名法:与骆驼命名法类似。
只不过骆驼命名法是首字母小写,而帕斯卡命名法是首字母大写,形如:public void DisplayInfo();string UserName;三、匈牙利命名法:匈牙利命名法广泛应用于象Microsoft Windows这样的环境中。
Windows 编程中用到的变量(还包括宏)的命名规则匈牙利命名法,这种命名技术是由一位能干的 Microsoft 程序员查尔斯·西蒙尼(Charles Simonyi) 提出的。
匈牙利命名法关键是:标识符的名字以一个或者多个小写字母开头作为前缀;前缀之后的是首字母大写的一个单词或多个单词组合,该单词要指明变量的用途。
形如:lblMsg、txtName等四、综述简单的说:MyData 就是一个帕斯卡命名的示例而myData是一个骆驼命名法,它第一个单词的第一个字母小写,后面的单词首字母大写,看起来像一个骆驼而iMyData是一个匈牙利命名法,它的小写的说明了它的型态,后面的和帕斯卡命名相同,指示了该变量的用途.在C#中,以帕斯卡命名法和骆驼命名法居多。
附录一:C#语言命名规范1.类命名:采用Pascal方式,不加任何前缀或后缀,在微软给出的建议中认为这些是冗余信息,形如:FileInfo2.方法命名:采用Pascal方式,使用动词或动词短语,形如Remove()或GetCharArray()等。
3.参数命名: 采用Camel方式,微软反对使用匈牙利命名方式,认为匈牙利命名方式与具体编程语言相关并且维护复杂,建议使用代表参数意义的名字,形如:userName;4.字段命名:对于public、protected或internal修饰的采用Pacal风格,提倡避免使用,如需使用可以用属性代替;对于private的采用Camel风格,微软不在提倡以_为前缀的field命名方式,形如:private string userName;5.对于Static或Const变量参见第4条。
数据库命名规范(表、字段名)一.实体和属性的命名1.常用单词已经进行了缩写,在命名过程当中,根据语义拼凑缩写即可。
注意,由于ORCAL 数据库会将字段名称统一成大写或者小写中的一种,所以要求加上下划线举例:定义的缩写 Sales: Sal 销售;Order: Ord 订单;Detail: Dtl 明细;则销售订单名细表命名为:Sal_Ord_Dtl;2.如果表或者是字段的名称仅有一个单词,那么建议不使用缩写,而是用完整的单词。
一、【操作规范】1. 如无备注,则表中的第一个id字段一定是主键且为自动增长;2. 如无备注,则数值类型的字段请使用UNSIGNED属性;3. 如无备注,排序字段order_id在程序中默认使用降序排列;4. 如无备注,所有字段都设置NOT NULL,并设置默认值;5. 如无备注,所有的布尔值字段,如is_hot、is_deleted,都必须设置一个默认值,并设为0;6. 所有的数字类型字段,都必须设置一个默认值,并设为0;7. 针对varchar类型字段的程序处理,请验证用户输入,不要超出其预设的长度;8. 建表时将数据字典中的字段中文名和属性备注写入数据表的备注中(“PK、自动增长”不用写);9. 如无说明,建表时一律采用innodb引擎;二、【常用表名约定】0. 说明:表前缀用项目名称首字母缩写;所以表名都小写,单词之间用下划线分开,单词都用单数形式1. user –用户2. category –分类3. goods –商品、产品等一切可交易网站的物品都用此命名4. good_gallery –物品的相册5. good_cate –物品的分类,除了单独作为表名,其他地方分类单词一律用缩写cate4. attr –属性5. article –文章、新闻、帮助中心等以文章形式出现的,一般都用此命名6. cart –购物车7. feedback –用户反馈8. order –订单9. site_nav –包括页头和页尾导航10. site_config –系统配置表11. admin –后台用户【RBAC标准表】12. role –后台用户角色【RBAC标准表】13. access –后台操作权限,相当于action【RBAC标准表】14. role_admin –后台用户对应的角色【RBAC标准表】15. access_role –后台角色对应的权限【RBAC标准表】16. 待续三、【常用列名约定】1. 表名_id –通常用作外键命名2. cid –特殊的编号,带有元数据,方便关联查询,你可以把它理解成类别(层次)编号。
命名规范_C(Sharp)1.命名规范a)类【规则1-1】使用Pascal规则命名类名,即首字母要大写。
【规则1-2】使用能够反映类功能的名词或名词短语命名类。
【规则1-3】不要使用“I”、“C”、“_”等特定含义前缀。
【规则1-4】自定义异常类应以Exception结尾。
【规则1-5】文件名要能反映类的内容,最好是和类同名。
b)类字段【规则2-1】用camel规则来命名类成员变量名称,即首单词(或单词缩写)小写。
【规则2-2】类字段变量名前可加“_”前缀。
【规则2-3】坚决禁止在普通变量前加“m_”(这是VC老命名规则)。
c)方法【规则3-1】方法名采用Pascal规则,第一个字符要大写。
【规则3-2】方法名应使用动词或动词短语。
【规则3-3】类中访问修饰符或功能相同的方法应该放在一起,且公共或实现接口的方法在前。
d)属性【规则4-1】使用名词定义属性,属性使用Pascal规则,首字符大写。
【规则4-2】属性和相应字段名称要关联,可以使用“重构”菜单来生成属性。
e)参数【规则5-1】参数采用camel规则命名,且首字符小写。
【规则5-2】使用描述性参数名称,参数名称应当具有最够的说明性。
【规则5-3】不要给参数加匈牙利语类型表示法的前缀。
【规则5-4】检查方法所有输入参数的有效性。
f)常量【规则6-1】只读常量使用Pascal命名规则,即首字母大写。
【规则6-2】枚举名使用Pascal规则命名,枚举成员本质属于常量,命名规则同上。
【规则6-3】枚举值从小到大顺序定义。
【规则6-4】静态字段或属性采用Pascal规则,即首字符大写。
g)接口【规则7-1】接口定义使用Pascal规则,且必须以大写“I”开头。
【规则7-2】接口名称要有意义,中间不要有下划线“_”等字符。
【规则7-3】如果类实现了接口,名称尽量和接口相同,只是省掉“I”字符。
h)事件【规则8-1】委托名称采用Pascal规则,即首字符大写。
1、合同编号规范HLC-HR-年月日/001(劳动合同)HLC-SL-年月日/001(销售合同)HLC-PC-年月日/001(采购合同)说明:HL为公司缩写C为Contract的缩写HR表示劳动合同范畴SL表示销售合同范畴PC表示采购合同范畴001开始为序列号2、固定资产编号HL-PA-RD/001(研发设备编号)HL-PA-IT/001(信息设备编号)HL-PA-TP/001(运输设备编号)HL-PA-RS/001(后勤设备编号)说明:HL为公司缩写PA为固定资产Permanent Assets的缩写RD表示研发设备IT表示电脑、打印机、交换机之类的信息设备TP表示汽车等运输设备RS表示行政后勤设备,如空调、办公家具等001开始为序列号3、表单编号HLT-HR/001-A1(人事表格)HLT-RD/001-A1(研发表格)HLT-MK/001-A1(市场表格)HLT-SL/001-A1(销售表格)HLT-AD/001-A1 (行政表格)HLT-FN/001-A1(财务表格)说明:HL为公司缩写T为表格Table的缩写HR表示人事部门、RD表示研发部门、MK表示市场部门、SL表示销售部门、AD表示行政部门、FN表示财务部门001开始为序列号A1表示版本号,如表格在原有基础上稍作调整则变动数字;如表格在原有基础上本质性调整则变动字母4、文件编号HLF-HR/001-A1(人事文件)HLF-RD/001-A1(研发文件)HLF-MK/001-A1(市场文件)HLF-SL/001-A1(销售文件)HLF-AD/001-A1 (行政文件)HLF-FN/001-A1(财务文件)说明:HL为公司缩写F为文件File的缩写HR表示人事部门、RD表示研发部门、MK表示市场部门、SL表示销售部门、AD表示行政部门、FN表示财务部门001开始为序列号A1表示版本号,如表格在原有基础上稍作调整则变动数字;如表格在原有基础上本质性调整则变动字母。
数据库命名规范(表、字段名)一.实体和属性的命名1.常用单词已经进行了缩写,在命名过程当中,根据语义拼凑缩写即可。
注意,由于ORCAL 数据库会将字段名称统一成大写或者小写中的一种,所以要求加上下划线举例:定义的缩写Sales: Sal 销售;Order: Ord 订单;Detail: Dtl 明细;则销售订单名细表命名为:Sal_Ord_Dtl;2.如果表或者是字段的名称仅有一个单词,那么建议不使用缩写,而是用完整的单词。
举例:定义的缩写Material Ma 物品;物品表名为:Material, 而不是Ma.但是字段物品编码则是:Ma_ID;而不是Material_ID3.所有的存储值列表的表前面加上前缀Z目的是将这些值列表类排序在数据库最后。
4.所有的冗余类的命名(主要是累计表)前面加上前缀X冗余类是为了提高数据库效率,非规范化数据库的时候加入的字段。
或者表5.关联类通过用下划线连接两个基本类之后,再加前缀R的方式命名,后面按照字母顺序罗列两个表名或者表名的缩写。
关联表用于保存多对多关系。
如果被关联的表名大于10个字母,必须将原来的表名的进行缩写。
如果没有其他原因,建议都使用缩写。
举例:表Object与自身存在多对多的关系,则保存多对多关系的表命名为:R_Object;表Depart和Employee;存在多对多的关系;则关联表命名为R_Dept_Emp6.每一个表都将有一个自动ID作为主健,逻辑上的主健作为第一组候选主健来定义,如果是数据库自动生成的编码,统一命名为:ID;如果是自定义的逻辑上的编码则用缩写加“ID”的方法命名。
举例:销售订单的编号字段命名:Sal_Ord_ID;如果还存在一个数据库生成的自动编号,则命名为:ID。
7.所有的属性加上有关类型的后缀,类型后缀的缩写定义见文件《类型后缀缩写定义》,注意,如果还需要其它的后缀,都放在类型后缀之前。
二.关系的命名关系的命名基本上按照;如有特殊情况,可以灵活处理.[must/may/can/should][verb/verb+prep][a/many/exatly num][or a/many]的结构命名三.域的命名四.触发器的命名五.有关于默认的几点说明1.严格依赖关系的主细表,主表的后缀Main可以不写。
Web UI 设计命名规范Web UI 设计命名规范 (1)一.网站设计及基本框架结构: (2)二.需要注意的几点: (2)一.网站设计及基本框架结构:1. Container“container“ 就是将页面中的所有元素包在一起的部分,这部分还可以命名为: “wrapper“, “wrap“, “page“.2. Header“header” 是网站页面的头部区域,一般来讲,它包含网站的logo和一些其他元素。
这部分还可以命名为:“page-header” (或 pageHeader).3. Navbar“navbar“等同于横向的导航栏,是最典型的网页元素。
这部分还可以命名为:“nav”, “navigation”, “nav-wrapper”.4. Menu“Menu”区域包含一般的链接和菜单,这部分还可以命名为: “subNav “, “links“,“sidebar-main”.5. Main“Main”是网站的主要区域,如果是博客的话它将包含的日志。
这部分还可以命名为: “content“, “main-content” (或“mainContent”)。
6. Sidebar“Sidebar” 部分可以包含网站的次要内容,比如最近更新内容列表、关于网站的介绍或广告元素等…这部分还可以命名为: “subNav “, “side-panel“, “secondary-content“.7. Footer“Footer”包含网站的一些附加信息,这部分还可以命名为: “copyright“.二.需要注意的几点:1.尽量考虑为元素命名其本身的作用或”用意”,达到语义化。
不要使用表面形式的命名.如:red/left/big等。
2.组合命名规则:[元素类型]-[元素作用/内容]如:搜索按钮: btn-search登录表单:form-login新闻列表:list-news3.涉及到交互行为的元素命名:凡涉及交互行为的元素通常会有正常、悬停、点击和已浏览等不同样式,命名可参考以下规则:鼠标悬停::hover 点击:click 已浏览:visited如:搜索按钮: btn-search、btn-search-hover、btn-search-visited推荐网页制作规范01 命名规范文件命名的原则:以最少的字母达到最容易理解的意义。
名称命名规则
在进行名称命名时,应当遵循以下规则:
1. 语言规范:名称应当用规范的中文书写,符合语言规范,不得使用方言或外语。
2. 准确性:名称应当准确、清晰,不能有歧义或多义性。
3. 简洁性:名称应当简洁明了,不要使用过于繁琐、冗长的字眼。
4. 唯一性:名称应当具有独特性,能够与其它名称区分开来。
5. 合法性:名称应当符合法律、法规及相关标准的规定,不得含有违法、违规、不健康的内容。
6. 不得涉及敏感信息:名称不得泄露任何有关隐私、机密或涉及国家安全的信息。
总之,在进行名称命名时,必须严格遵守相关规范和标准,确保名称的准确性、唯一性和合法性。
命名规范(Oracle数据库)1、表命名命名最好望⽂⽣义,避免使⽤[数据库]关键词命名⼀律为⼤写字母(或⼩写,不要⼤下写混合)英⽂单词单数命名,例:FACTORY英⽂单词缩写命名,例:DEPT英⽂单词之间⽤下划线连结,且每个单词皆为单数,例:TASK_RESULT⽤来存储历史资料,命名以HISTORY结尾,例:TASK_HISTORY⽤来存储⽇志资料,命名以LOG结尾,例:TASK_LOG⽤来存储类别资料,命名以TYPE结尾,例:TASK_TYPE2、表字段命名最好望⽂⽣义,避免使⽤数据库关键词英⽂单词单数命名,例:MAIL英⽂单词缩写命名,例:DEPT_ID英⽂单词之间⽤下划线连结,且每个单词皆为单数,例:USER_NAME字段⽤来存储流⽔号,命名以ID结尾,例: TASK_ID字段⽤来存储代码,命名以NO结尾,例: TASK_NO字段⽤来存储⽇期,命名以DATE结尾,例:CREATE_DATE字段⽤来存储数量,命名以QTY结尾,例:PLAN_QTY字段⽤来存储类别,命名以TYPE结尾,例:STATION_TYPE字段⽤来存储名称,命名以NAME结尾,例:ENDUSER_NAME字段⽤来存储描述,命名以DESC结尾,例:STATION_DESC字段⽤来存储代码,命名以CODE结尾,例:ERROR_CODE字段⽤来存储标志,命名以FLAG开头,例:DEBUG_FLAG3、索引命名以表名+ INDEX+两位流⽔号(01~99),例:ENDUSER_INDEX014、键值主键命名以表名+PK+⼀位流⽔号(1~9),例:DEPT_PK1附键命名以表名+AK+⼀位流⽔号(1~9),例:DEPT_AK1外键命名以表名+FK+⼀位流⽔号(1~9),例:DEPT_FK1检查条件以表名+CK+⼀位流⽔号(1~9),例:DEPT_CK15、视图命名以V_开头例:V_DEPT其它规则参考资料表命名规则6、触发器以表名+TR+⼀位流⽔号(1~9) 命名,例:DEPT_TR17、存储过程命名以PC开头实现单⼀资料表交易功能,以PC+表名命名,例:PC_LINE实现关联资料表交易功能,以PC+功能命名,例:PC_GETDATA命名需让⼈明⽩其主要功能8、函数检查功能的函数,以Is+检查项⽬命名,例:bool IsCharValid(char)获取资料功能的函数,以Get+数据项命名,例:string GetLineNo(char)设定资料功能的函数,以Set+数据项命名,例:int SetLineNo(char)9、序列命名以SEQ开头以表的字段名命名,例: SEQ_LINE_ID若与其它表的字段名相同,则以表名+字段名命名,例:SEQ_CODE_TYPE_ID10、表空间存储资料的命名为项⽬名称,例:CRM存储索引的命名为项⽬名称+IDX,例:CRMIDX存储历史的命名为项⽬名称+OLD,例:CRMOLD存储临时的命名为项⽬名称+LOG,例:CRMLOG11、数据⽂件命名以所属表空间开头+两位流⽔号(01~99)+,ORA,例:CRM01,ORA12、包命名以功能缩写开头+PKG+流⽔号(1~9),例:CRMPKG113、⽤户项⽬管理者以项⽬名称命名,例:CRM开发者通⽤名称DEVELOPER初学者通⽤名称BEGINNER。