作为一名前端开发,代码的可读性是一项基本要求,命名规范可以很大程度上影响项目的质量、降低代码的维护成本,下面就记录了一些我的日常规范。
文件资源命名
- 文件名包含多个单词时,单词之间建议使用半角的连词线 ( - ) 分隔;
- 文件名建议只使用小写字母,使用大写字母时多为说明文件;
- 引入资源使用相对路径,不要指定资源所带的具体协议 ( http:,https: ) 。
类名
//整体布局:wrapper
//头部:header
//内容:content/container
//导航:nav
//子导航:subnav
//侧栏:sidebar
//广告:banner
//菜单:menu
//子菜单:submenu
//搜索:search
//尾部:footer
- 颜色:使用颜色的名称或者16进制代码;
- 字体大小:直接使用“font+字体大小”作为名称;
- 对齐样式:使用对齐目标的英文名称 。
变量
多为数据类型+名称,若不清楚具体类型也可直接使用名称,采用小驼峰命名规则,常用的如下:
数据类型 | 简写 |
---|---|
数组 | arr |
对象 | obj |
正则 | r |
函数 | fn |
常量
使用大写字母和下划线来组合命名,下划线用以分割单词。
函数
构造函数采用大驼峰命名规则,其他则采用小驼峰命名规则,以动词开头。
其他
- img标签的alt属性必填,利于seo。