命名规范指引

《命名规范指引》由会员上传分享，免费在线阅读，更多相关内容在应用文档-天天文库。

1、命名规范指引v1.0刘豹目录1.0概述62.0命名规范遵守的原则62.1首要原则62.1.1严肃对待62.1.2要名副其实62.1.3命名要避免误导62.1.4有意义的分类62.1.5传达一致设计意图的前后缀72.1.6不断更新72.2.NET命名规则的特殊考虑点和补充73.0命名样式风格73.1命名样式分类74.0HTML命名规则84.1HTML标签前缀84.2特定含义DIV命名单词84.2.1表达页面结构84.2.2表达导航94.2.3表达功能94.3样式选择94.4注意事项105.0CSS命名规则105.1CSS常用样式前缀105.2CSS命

2、名样式选择115.3CSS样式组织规范115.4CSS样式书写规范116.0JS命名规则126.1JS样式前缀126.1.1局部变量前缀126.1.2含义连续型前后缀126.2命名样式选择126.3JS语句格式条款136.4关于注释157.0.NET命名规则167.1.NET样式前缀167.1.1控件前缀167.1.2设计前后缀177.2样式选择177.3特有的项目规范188.0数据库命名规则188.1数据库对象样式前缀188.2子系统前缀188.3样式选择191.0概述为了统一公司软件开发人员的代码风格，避免因没有命名指引而导致的代码命名混乱，特

3、制定了本命名规范指引文档，用以统一编码风格，便于后续代码的管理和维护。请在正式开发之前，确保理解了命名原则和熟悉了解所有命名规则条款。请遵循本文档制定的规范编码。2.0命名规范遵守的原则2.1首要原则命名：有意义的命名，一眼就可以看出名称表达出的准确含义。2.1.1严肃对待取一个好的、恰当的名字，让别人更容易看到名称所表达的含义。这件事情要严肃对待，我们宁可花时间在起易懂的名字上面。2.1.2要名副其实如果名称需要注释来补充说明含义，那就不是“名副其实”。2.1.3命名要避免误导取名必须避免留下掩藏代码本意的错误线索。Demo:accountLis

4、t这个名字就不太好，因为list这个词在.NET中是一个类型，如果这个名字表达的类型或者含义不是list就不应该这样命名。2.1.4有意义的分类不同的命名样式，应该尽量对他们表达的语义来分类。DEMO：数据库命名规则，Sys_前缀表达系统基础表，Bu_开头表达业务表。2.1.5传达一致设计意图的前后缀前、后缀的命名样式设计，必须考虑要一致的语义，而不仅仅是表达类型这一种用途。2.1.6不断更新本文档依然在随着系统发展而不断更新，请注意索取最新版本。2.2.NET命名规则的特殊考虑点和补充n应该遵循.NETFramework的约定，惯用法与模式n应该

5、为平台基础类库考虑保留用法n为常用的设计模式保留特定的前后缀n为有相反语义的API设计语义一致的前缀或者后缀²3.0命名样式风格3.1命名样式分类名称说明例子驼峰式（PascalCasing）每个单词的首字母都大写AccountEventManager小驼峰式（CamelCasing）首字母小写，而后面的每个单词的首字母大写；其他字母小写userName连接式每个单词都小写,单词间用-连接grid-content小写每个单词小写input大写每个单词大写WEB组合式由以上样式+特定的前后缀或者连接字符WEB_SITE_ROOT_PATHcanDel

6、ete专属属于框架底层通用的特殊命名规则，比如说单字母大写这种用法只能在框架通用基础类库里面，一般开发部允许使用单大写字母命名FC注意：只有在开发平台框架和通用基础类库时才会可能有专属的用法，一般开发不允许选择专属单字母这种命名样式风格。这种风格是为平台常用、高频率方法而特别保留的。4.0HTML命名规则4.1HTML标签前缀控件类型前缀文本框txt下拉框ddl单选框rdo复选框chk隐藏控件hid按钮btn图片imgIFRAME标签ifmSPAN标签spnDIV标签divA标签lnkTABLE标签tblTR标签trTD标签td4.2特定含义DIV

7、命名单词4.2.1表达页面结构标签内容描述前缀容器container页头header内容content/container页面主体main页尾footer导航nav侧栏sidebar栏目col页面外围控制整体布局宽度wrapper左右中leftrightcenter4.2.2表达导航标签内容描述前缀导航nav主导航mainnav子导航subnav顶导航topnav边导航sidenav左导航leftnav右导航rightnav菜单menu子菜单submenu标题title摘要summary4.2.3表达功能标签内容描述前缀标志logo广告banner

8、登陆login登录条loginbar注册regsiter搜索search滚动scroll状态status提示信息msg4.