JS命名规范

2017-07-20  本文已影响0人  lydia56

js:驼峰 firstName
css:中划线 first-name
class : FirstName
html : data-first-name(id:firstName)
文件:中/下划线
图片:头尾两部分,下划线隔开,头表示大类(banner:放置在页面顶部的广告,装饰图案等长方形的图片
logo:标志性的图片
button:在页面上位置不固定,并且带有链接的小图片
menu:在页面中某一位置连续出现,性质相同的链接栏目的图片
pic:装饰用的图片
例子:
banner_sohu.gif, banner_sina.gif
menu_aboutus.gif,menu_job.gif
title_news.gif
logo_police.gif
pic_people.gif)

文件名称:小写英文字母,数字和下划线(首页—index 产品列表—prelist 产品详细页面—prodetail 新闻列表—newslist
新闻详细页面—newsdetail 发展历史—history 关于我们—aboutus 联系我们—linkus,contactus
信息反馈—feedback 留言—leavewords)
脚本文件和动态文本:英文小写缩写命名(广告条ad.js,弹出窗口pop.js
公用模块:js文件命名:英文命名,后缀js。如common.js,basic.js
外部资源:Jquery.min.js,Jquery.validate.js,Jquery.date.js
动态文件:以性质描述,可以有多个单词,用‘_’隔开,性质一般是该页面的概要(见名知意)。
范例:register_form.aspx,register_post.aspx,topic_lock.aspx)

常用规范
• s:表示字符串。例如:sName,sHtml;
n:表示数字。例如:nPage,nTotal;
b:表示逻辑。例如:bChecked,bHasLogin;
a:表示数组。例如:aList,aGroup;
r:表示正则表达式。例如:rDomain,rEmail;
f:表示函数。例如:fGetHtml,fInit;
o:表示以上未涉及到的其他对象,例如:oButton,oDate;
g:表示全局变量,例如:gUserName,gLoginTime;

常量

• 某些作为不允许修改值的变量认为是常量,全部字母都大写。
• 例如:COPYRIGHT,PI。
• 常量可以存在于函数中,也可以存在于全局。
Jquery
• $:表示Jquery对象。例如:$Content,$Module;
一种比较广泛的Jquery对象变量命名规范。

j:表示Jquery对象。例如:jContent, jModule;
另一种Jquery对象变量命名方式。
函数
• fn:表示函数。例如:fnGetName,fnSetAge;
• fn能够更好的区分普通变量和函数变量。
dom
• dom:表示Dom对象,例如:domForm,domInput;
项目中很多地方会用到原生的Dom方法及属性,可以根据团队需要适当修改。
临时变量
• 1:作用域不大临时变量可以简写,比如:str,num,bol,obj,fun,arr。
2:循环变量可以简写,比如:i,j,k等。
常用动词
• get 获取/set 设置/add 增加/remove 删除/create 创建/destory 移除
• start 启动/stop 停止/open 打开/close 关闭/read 读取/write 写入
• load 载入/save 保存/create 创建/destroy 销毁
• begin 开始/end 结束/backup 备份/restore 恢复/detach 脱离
• import 导入/export 导出/split 分割/merge 合并/inject 注入/extract 提取
• attach 附着/bind 绑定/separate 分离/ view 查看/browse 浏览
• edit 编辑/modify 修改/select 选取/mark 标记/copy 复制/paste 粘贴/undo 撤销
• redo 重做/insert 插入/delete 移除/add 加入/append 添加
• clean 清理/clear 清除/index 索引/sort 排序/find 查找/search 搜索/
• increase 增加/decrease 减少/play 播放/pause 暂停/
• launch 启动/run 运行/pack 打包/unpack 解包/parse 解析/emit 生成
• compile 编译/execute 执行/debug 调试/trace 跟踪
• observe 观察/listen 监听/build 构建/publish 发布/push 推/pull 拉
• input 输入/output 输出/encode 编码/decode 解码
• expand 展开/collapse 折叠/encrypt 加密/decrypt 解密
• compress 压缩/decompress 解压缩
• connect 连接/disconnect 断开/send 发送/receive 接收
• download 下载/upload 上传/refresh 刷新/synchronize 同步
• update 更新/revert 复原/lock 锁定/unlock 解锁
• check out 签出/check in 签入/submit 提交/commit 交付
• begin 起始/end 结束/start 开始/finish 完成/enter 进入/exit 退出
• abort 放弃/quit 离开/obsolete 废弃/depreciate 废旧
• collect 收集/aggregate 聚集

上一篇下一篇

猜你喜欢

热点阅读