Skip to content

编写规范

  • 在每条可执行的语句之后添加分号,以分号作为这条语句的结束(分号不加也不会报错,但是为了规范,建议都加上)如果有分号分隔,允许在同一行写多条语句

  • 添加空格增加代码的可读性


普通变量命名

  • 小驼峰式命名:首字母小写+驼峰式命名,如:myCheck

  • 匈牙利命名:变量名=类型+对象描述

    JavaScript变量起名类型变量命名前缀举例
    Array数组aaListaGroup
    Boolean逻辑bbCheckedbHasLogin
    Function函数f/fnfnGetHtmlfnInit, fSetName
    Integer数字nnPagenTotal
    Object对象ooButtonoDate
    Regular Expression正则rrDomainrEmail
  • 作用域不大的临时变量可以进行简写:

    循环变量可以简写,比如:i,j,k 等;

  • 常量(某些作为不允许修改值的变量),全部字母都大写,例如:COPYRIGHTPI;常量可以存在于函数中,也可以存在于全局,必须采用全大写的命名,且单词以_进行分隔,常量通常用于设置 ajax 请求 url的相关参数,和一些不会进行改变的数据


构造函数(类)命名

  • 普通函数:首字母小写,驼峰式命名,统一使用动词或者动词+名词形式,如:fnGetVersion()

  • 涉及返回逻辑值的函数可以使用 ishascontains 等表示逻辑的词语代替动词,如:fnIsObject()

  • 内部函数(函数内部嵌套函数):使用_fn+动词+名词形式,内部函数必需在函数最后定义

  • 对象方法与事件响应函数:对象方法命名使用 fn+对象类名+动词+名词形式,如:fnAddressGetEmail()

  • 事件响应函数:fn+触发事件对象名+事件名或者模块名,如:fnAddressSubmitButtonClick()

函数方法常用的动词:

动词动词动词动词
get 获取/set 设置launch 启动/run 运行add 增加/remove 删除compile 编译/execute 执行
create 创建/destory 移除debug 调试/trace 跟踪start 启动/stop 停止observe 观察/listen 监听
open 打开/close 关闭build 构建/publish 发布read 读取/write 写入input 输入/output 输出
load 载入/save 保存encode 编码/decode 解码create 创建/destroy 销毁encrypt 加密/decrypt 解密
begin 开始/end 结束compress 压缩/decompress 解压缩backup 备份/restore 恢复pack 打包/unpack 解包
import 导入/export 导出parse 解析/emit 生成split 分割/merge 合并connect 连接/disconnect 断开
inject 注入/extract 提取send 发送/receive 接收attach 附着/detach 脱离download 下载/upload 上传
bind 绑定/separate 分离refresh 刷新/synchronize 同步view 查看/browse 浏览update 更新/revert 复原
edit 编辑/modify 修改lock 锁定/unlock 解锁select 选取/mark 标记check out 签出/check in 签入
copy 复制/paste 粘贴submit 提交/commit 交付undo 撤销/redo 重做push 推/pull
insert 插入/delete 移除expand 展开/collapse 折叠add 加入/append 添加begin 起始/end 结束
clean 清理/clear 清除start 开始/finish 完成index 索引/sort 排序enter 进入/exit 退出
find 查找/search 搜索abort 放弃/quit 离开increase 增加/decrease 减少obsolete 废弃/depreciate 废旧
play 播放/pause 暂停collect 收集/aggregate 聚集

注释

  • 公共组件需要在文件头部加上注释说明:

    js
    /**
    * 文件用途说明
    * 作者姓名、联系方式
    * 制作日期
    **/
  • 大的模块注释方法:

    js
    //================
    // 代码用途
    //================
  • 小的释:注释单独一行放在上面,不要在代码后的同一行内加注释

    js
    // 代码说明

引号的使用

单引号优先(如果不是引号嵌套,不要使用双引号)


对代码进行折行

如果 JavaScript 语句太长,对其进行折行的最佳位置是某个运算符,如果没有运算符,也可以在文本字符串中使用反斜杠对代码行进行换行

js
document.write("hellow \
js!");

Released under the MIT License.