前端命名规范(待完善)

  • 项目命名

    全小写,用_隔开
    例: my_project_name

  • 文件命名

    小写开头、驼峰命名
    例:apiUtil.html

  • 目录命名

    全小写

  • CSS命名

    1.位置属性(position, top, right, z-index, display, float等)
    2.大小(width, height, padding, margin)
    3.文字系列(font, line-height, letter-spacing, color- text-align等)
    4.背景(background, border等)
    5.其他(animation, transition等)

    2)属性用简写

    3)去除小数点前面0
    例:.8rem

    4)命名全小写,用-隔开
    例:main-title

  • JS命名规范

    变量:
    小驼峰
    例:maxCount

    常量:
    全大写_隔开
    例:MAX_COUNT

    方法:
    小驼峰、前缀应当为动词(get/set/is/has/can/load)
    例:getData()

    类:
    大驼峰,首字母大写
    例:Person

    私有属性:
    前缀为_
    _name

    boolean类型:
    用is或has开头
    例:isReady

  • 注释

    文件:
    文件顶部需包含文件描述,
    例:

 /**
 * @file Describe the file
 * @author:xxx
 */

函数:
【强制】 函数/方法注释必须包含函数说明,有参数和返回值时必须使用注释标识。
【强制】 参数和返回值注释必须包含类型信息和说明。
【建议】 当函数是内部函数,外部不可访问时,可以使用 @inner 标识。

/**
 * 函数描述
 *
 * @param {string} p1 参数1的说明
 * @param {string} p2 参数2的说明,比较长
 *     那就换行了.
 * @param {number=} p3 参数3的说明(可选)
 * @return {Object} 返回值描述
 */
function foo(p1, p2, p3) {
    var p3 = p3 || 10;
    return {
        p1: p1,
        p2: p2,
        p3: p3
    };
}
©️2020 CSDN 皮肤主题: 大白 设计师:CSDN官方博客 返回首页