1) 命名规范
1.文件/文件夹 命名: 使用 全小写英文 + "-"
2.常量命名: 全大写英文 + "_"
3.变量命名: 驼峰命名, 并且具有解释性(特殊情况可用 _ 做前缀)
good:
文件名: user-center.js
常量: const MODULE_NUM = 10
变量: let bookNum = 10
bad:
文件名: userCenter.js
常量: const moduleNum = 10
变量: let booknum = 10
2) 组件相关
1.组件首部注释说明: 入参描述, 返回事件描述, 关键方法功能描述
2.属性注释说明
3.�方法注释说明
4.若有事件中心事件的 监听/发送, 需要更新事件中心文件注释
5.避免非当前组件方法调用
/**
* props:
* @param {string} type - 显示类型(可选): solid(default), dotted, dashed
* events:
* @event send-message - 发送信息(message)
* - @param {string} message - 返回信息
* methods:
* @function handleMessage - 信息相关处理
*/
export default {
data () {
return {
userName: '' // 用户名称
}
},
methods: {
init () { // 组件 UI 初始化 - 简单注释
},
/**
* 保存用户名称
* @param {string} name - 保存名称
*/
saveUserName (name) {
// ...
}
}
}
events list:
1) copypage-to
控制文件:@/views/edit/mixin/reportCatalog/reportCatalog.vue
-> @/views/edit/view/edit.vue
功能: 简报页复制至 弹窗
3) 请求异常处理
1.请求 成功/失败/异常 处理
this.$http.post(url, params).then(res => {
if (res.body.code === 0) {
// 成功处理
} else {
// 失败处理
}
}).catch(err => {
// 异常处理
})
4) todo 格式
TODO: + 说明：
如果代码中有该标识，说明在标识处有功能代码待编写，待实现的功能在说明中会简略说明。
FIXME: + 说明：
如果代码中有该标识，说明标识处代码需要修正，甚至代码是错误的，不能工作，需要修复，如何修正会在说明中简略说明。
例子:
- 多行书写
/**
* TODO:
* - ...
* - ...
*/
/**
* FIXME:
* - ...
* - ...
*/
- 单行书写
// TODO: 描述
// FIXME: 描述
