• 返回前端专题 >
  • 首页
  • CMS规范
  • 切割规范
  • 脚本规范
  • SEO规范
  • SVN操作说明
通用编写规范
  • 函数规则
  • 变量命名
  • 代码书写规范
  • 注释的写法
  • JS文件命名
  • 脚本在页面中放置位置
JQuery通用库使用规范
  • Jquery通用库说明
  • 已部署jquery的站群

1. 函数规则

1.1 针对原生JS

对于任何一个新增的js代码要求用一个大的function包含起来,以大写 “ UE_ ” 作为开头(下划线紧跟的第一个字母大写),函数的书写方式如图1所示:


图1

1.2 针对jQuery

对于扩展插件请使用匿名函数包裹,外调方法以大写 “ UE_ ”开头:


图2

2. 变量命名

2.1 不使用全局变量

请不要使用全局变量,如图3所示:

2.2 小驼峰式书写格式

书写规则:

  • 第一个单词以小写字母开始;第二个单字的首字母大写,例如:firstName、lastName。
  • 以语义化书写为准,即所使用单词能较直观指示其含义。

推荐写法:

  • 方法采用动名词的形式命名。如:doFunction(),setFunction(),getFunction()等等
  • 变量采用名词的形式命名。如:clientWidth,scrollTop等等

其他建议写法:

  • 建议1:大驼峰式命名法只做外围类或接口名
  • 建议2:$开头的只做jq对象
  • 建议3:_开头的为临时的,接口属性或外调尽量不用
  • 建议4:常量必须所有单词大写,并且每个单词间加下划线,这是单词间加下划线唯一使用的地方

3. 代码书写规范

代码有层次感,注意缩进跟空格的使用。
下图是代码书写的参考模式:

注意事项:

  • 变量定义写在函数体头部
  • 各语句间尽量加空行,防止过于紧密
  • 注意if,for,while,switch 语句的书写格式(大括号的位置)

4. 注释的写法

注释请尽量使用英文,避免引起冲突。

4.1 JS文件头部声明

头部声明包括三大要素:功能,版本,作者
因为文件命名的特殊性,从文件的名称通常就可以看出出处,以及大体的功能。如图5所示:


图5

4.2 JS重要变量或方法注释

对于一些比较重要的变量或者方法,请在前端加上注释。如图6所示:


图6

4.3 JS从属关系声明

概念说明:

页面内部块,如

外联,如

5. JS文件命名

采用小写来命名,便于浏览器跟系统的识别。

命名格式:

原生JS ue.类型.功能.时间.js
jQuery ue.jq.类型.功能.时间.js

类型一般分以下几种:

  1. 1) 类型:pub 公用js,即是被多个页面引用。如:公用头部,公用底部的js。(public)
  2. 2) 类型:pri 为某个特定的页面提供特定功能的。如:图片定时滚动效果。(private)
  3. 3) 类型:dis 负责将某个结构输出到页面上的,如图8所示。(display)

应用举例:

比如,一般来说每个站点都有个公共文件,那么这个公共文件就可以取名(拿mmosite的download来讲),可以写成ue. pub. download. Js(如图9所示)

又比如:
网站现在要加个换肤的功能,这时这个换肤的js就可以取名
ue. pri. changeStyle. Js

这种命名方式可通过.pub,.pri来指明这个文件是公用的还是用来具体实现某一特定功能用的,另外ue.用作区分该js是程序提供的还是ue提供的。

6. 脚本在页面中放置位置

6.1 <head>之间

同时对于任何一个js文件请放置到css文件的后面,这样有利于文件的并行加载。Js文件如无特殊情况(类似include的需要之类的)一般放置到head里面去。

6.2 <body>具体显示位置

此类放置适用于需要将内容输出到某个具体位置或者加载某项具体功能,避免四处放置。

对于直接嵌入到页面中的代码,请用一个注释标注出自的文件。 格式 “ //From:文件名 ”

1. Jquery通用库说明

Jquery通用库为UE前端组根据常用页面特效做的效果集合,代码多次优化,定制性较强,目前广泛应用于各个站群的建设。页面常用的js效果均可在此库中找到。方便统一。

2. 已部署jquery的站群