样式指南style-guide

1.文件/文件夹

命名采用均采用 全小写英文 + "-"

2.样式 class 规范

1.使用样式命名空间作为前缀
2.使用 全小写英文 + "-" 拼接, 单个 class "-" 数量不能超过 4 个
3.样式 class 嵌套不能超过 3 级

常量/变量 的 声明

1.变量使用 let, 常量使用 const
2.常量命名： 全大写英文 + "_"
3.变量命名: 1) 驼峰 2) 函数内指向变量可使用 "_" + 驼峰
4.语义明确

函数/方法 命名

1.使用动词为首单词
2.使用驼峰命名 functionName, 组件混入 使用 $_private_functionName

函数注释

1.遵循 JSDoc
2.入参/返回 为必要注释
3.函数内部有复杂逻辑需要进行注释

分号的使用

vue 项目不使用, react 项目使用

引号的使用

1.html/css 使用双引号
2.js 使用单引号

组件

1.组件首部添加注释, 描述 入参/事件/关键方法
2.属性添加注释
3.方法添加注释
4.避免调用其他组件方法, 使用事件发送进行通知, 并更新事件中心注释
5.name 为必须, 使用 pascal
6.组件模板 属性/事件 书写分行
7.组件引入声明使用 pascal, 书写到模板使用 小写英文 + '-'

请求处理

必要状态处理: 成功/失败/异常 均需有对应处理