前端命名规范

581 阅读2分钟

驼峰式命名法介绍

  1. 大驼峰式命名法:首字母大写。eg:StudentInfo、UserInfo、ProductInfo
  2. 小驼峰式命名法:首字母小写。eg:studentInfo、userInfo、productInfo

文件资源命名

  1. 文件名不得含有空格
  2. 文件名建议只使用小写字母,不使用大写字母。( 为了醒目,某些说明文件的文件名,可以使用大写字母,比如README、LICENSE。 )
  3. 文件名包含多个单词时,单词之间建议使用半角的连词线 ( - ) 分隔。
  4. 引入资源使用相对路径,不要指定资源所带的具体协议 ( http:,https: ) ,除非这两者协议都不可用。

变量命名

  1. 命名方式 : 小驼峰式命名方法
  2. 命名规范 : 类型+对象描述的方式,如果没有明确的类型,就可以使前缀为名词
    类型 小写字母
    array a
    boolean b
    function fn
    int i
    object obj
    regular re
    string s

推荐: var tableTitle = "LoginTable"

函数

  1. 命名方式 : 小驼峰方式 ( 构造函数使用大驼峰命名法 )
  2. 命名规则 : 前缀为动词
    动词 含义 返回值
    can 判断是否可执行某个动作 ( 权限 ) 函数返回一个布尔值。true:可执行;false:不可执行
    has 判断是否含有某个值 函数返回一个布尔值。true:含有此值;false:不含有此值
    is 判断是否为某个值 函数返回一个布尔值。true:为某个值;false:不为某个值
    get 获取某个值 函数返回一个非布尔值
    set 设置某个值 无返回值、返回是否设置成功或者返回链式对象

推荐:

function getName{
    return this.name
}

常量

  1. 命名方法 : 全部大写
  2. 命名规范 : 使用大写字母和下划线来组合命名,下划线用以分割单词。
 var MAX_COUNT = 10;
 var URL = 'http://www.baidu.com';

注释规范

单行注释 ( // )

  1. 单独一行://(双斜线)与注释文字之间保留一个空格
  2. 在代码后面添加注释://(双斜线)与代码之间保留一个空格,并且//(双斜线)与注释文字之间保留一个空格。
  3. 注释代码://(双斜线)与代码之间保留一个空格。

多行注释 ( / 注释说明 / )

  1. 若开始(/和结束(/)都在一行,推荐采用单行注释 若至少三行注释时,第一行为/,最后行为/,其他行以开始,并且注释文字与保留一个空格。