【前端】前端开发规范文档

方便自己以后项目的使用，整理一套自己的开发规范。

一、文件名

1. 文件名使用【小写字母】命名方式。
2. 文件名包含多个单词时，使用半角的连接符（-）拼接，如 home-page。
3. 某些说明文件，文件名可以使用大写字母，如 README。

二、常量命名

1. 常量名使用【大写字母和下划线】命名方式。
2. 常量名的定义方式使用const关键字定义。
3. 常量名包含多个单词时，使用半角的下划线（_）拼接，如 MAX_COUNT。

三、变量命名

1. 全局变量使用【类型+半角的下划线（_）+小驼峰】命名方法，并使用var关键字定义，如 str_className。
2. 局部变量使用【半角的下划线（_）+类型+半角的下划线（_）+小驼峰】命名方法，并使用let关键字定义，如 _str_userName。
3. 如全局变量没有具体类型就使用【小驼峰】命名方法，如 className。
4. 如局部变量没有具体类型就使用【半角的下划线（_）+小驼峰】命名方法，如 _userName。
5. 如变量有具体类型应使用下面的方式定义：

类型	命名方式
Undefined	un_变量名
Null	nu_变量名
Boolean	bl_变量名
String	str_变量名
Number	num_变量名
Object	obj_变量名
Array	arr_变量名
Funtion	fn_变量名

 

 

 

 

 

 

 

 

 

四、函数命名

1. 函数命名使用【功能+大驼峰】命名方式，如 getUserList。
2. 如函数没有具体功能就使用【小驼峰】命名方式，如 userList。
3. 函数功能词命名参考（部分）：

功能词	定义
get	获取值
set	设置值
can	判断能否做什么
has	判断是否有什么
is	判断是否是什么
change	改变回调
click	点击回调

 

 

 

 

 

 

 

 

 

五、布局命名

1. 页面的整体布局使用id起名（特殊情况除外），如 <div id="container"></div>。
2. 整体布局中的局部块使用class起名（特殊情况除外），如 <div class="item"></div>。
3. 大同小异的样式应使用相同类名定义，再起语义化的第二个类名。

待更新...

 

 

以上命名规范仅是为了自己团队使用，不喜请自己规定。