前端规范

Posted 2020-10-04

总则：

1、注释（非常重要），提倡多少行代码多少条注释，一半一半

2、格式化代码，缩进、对齐、整齐排列

3、命名一律使用英文名称，并且以 功能-模块-具体 的方式命名

 

html：

1、每个页面模块都需要做注释

2、class 只用于样式，id只用于JS，data-*只用于数据及列表循环

3、语义化代码

4、合理切套代码

5、一个元素中的样式建议最多3-4个

 

CSS：

1、名称统一使用 ”a-b-c-*“的形式

2、输入顺序为 定位/块 > 布局宽高 > 边距 > 背景 > 字体字号颜色 > 其他 

3、避免以html元素名称的方式输写样式

4、除非确认此样式是某个页面独有，否则不建议将样式写在页面中

 

javascript：

1、命名方式 驼峰式

2、变量的定义建议每个都使用 var 形式

3、功能性效果建议封装成插件

4、为了区别是jQuery还是原生创建的变量，建议jQuery创建的变量使用 $ 前缀

5、变量声明建议统一放在闭包的最前面（特殊情况例外）

6、