更新编码规范文档到v2.3.5

This commit is contained in:
Billy 2022-08-31 09:36:53 +08:00
parent c9565a583b
commit 2bb022f8bc
1 changed files with 17 additions and 12 deletions

View File

@ -2,8 +2,8 @@
* @Author: Billy * @Author: Billy
* @Date: 2021-07-13 09:00:16 * @Date: 2021-07-13 09:00:16
* @LastEditors: Billy * @LastEditors: Billy
* @LastEditTime: 2022-07-04 17:34:25 * @LastEditTime: 2022-08-31 09:36:35
* @Description: v2.3.1 * @Description: v2.3.5
--> -->
## 前端项目目录结构 ## 前端项目目录结构
@ -56,15 +56,20 @@
├─main.js ├─main.js
## 编码格式 ## 编码格式
* 习惯性用 ";" 作为语句结尾 1. 习惯性用 ";" 作为语句结尾
* 单行注释文字前面加一个空格,如:// 注释 1. 单行注释文字前面加一个空格,如:// 注释
* Vue 组件的 props 必须全部写明注释 1. Vue 组件的 props 必须全部写明注释
* Vue 组件的 data 必须至少有 50% 写注释 1. Vue 组件的 data 必须至少有 50% 写注释
* Vue 组件的 methods 方法,必须用小驼峰命名法,除了留给父组件调用的方法要用大驼峰命名法 1. Vue 组件的 methods 方法,必须用小驼峰命名法,除了留给父组件调用的方法要用大驼峰命名法
* 事件回调函数的命名,必须以 on 或 handle 开头;而且同一个文件中,只能全用 on 或全用 handle 1. 事件回调函数的命名,必须以 on 或 handle 开头;而且同一个文件中,只能全用 on 或全用 handle
* 事件名,以 全小写 或 全小写+横杠 命名tree-node-selected并且不能以 on 或 handle 开头 1. 事件名,以 全小写 或 全小写+横杠 命名tree-node-selected并且不能以 on 或 handle 开头
* 常量名,以 全大写 或 全大写+下划线 命名BASE_URL 1. 常量名,以 全大写 或 全大写+下划线 命名BASE_URL
* "枚举型"的常量,以 ENUM 开头 1. "枚举型"的常量,以 ENUM 开头
1. import ... from xxx.yyyxxx.yyy 必须要写上 .yyy 后缀名,不能省略
1. Vue 组件的 name 不要设置,组件名默认就是组件文件的文件名
1. 判断是否相等,不用 ==,用 ===
## 样式规范 ## 样式规范
* 原则上,所有像素(px)的数值要么是1要么是2(极少时候)要么是4的倍数(即4px, 8px...16px, 20px...32px 等等) 1. 原则上,所有像素(px)的数值要么是1要么是2(极少时候)要么是4的倍数(即4px, 8px...16px, 20px...32px 等等)字体大小可以是14px
1. 类名以 全小写 或 全小写+横杠 命名,少用或不用 id
1. Vue 组件最外层的 div类名用组件文件名的 小写 或 小写+横杠命名,如:组件文件名叫 CloudDesktop.vue则组件最外层的 div 这样写 `<div class="cloud-desktop"></div>`