1) 命名規(guī)范
1.文件/文件夾 命名: 使用 全小寫英文 + "-"
2.常量命名: 全大寫英文 + "_"
3.變量命名: 駝峰命名, 并且具有解釋性(特殊情況可用 _ 做前綴)
good:
文件名: user-center.js
常量: const MODULE_NUM = 10
變量: let bookNum = 10
bad:
文件名: userCenter.js
常量: const moduleNum = 10
變量: let booknum = 10
2) 組件相關(guān)
1.組件首部注釋說(shuō)明: 入?yún)⒚枋? 返回事件描述, 關(guān)鍵方法功能描述
2.屬性注釋說(shuō)明
3.?方法注釋說(shuō)明
4.若有事件中心事件的 監(jiān)聽(tīng)/發(fā)送, 需要更新事件中心文件注釋
5.避免非當(dāng)前組件方法調(diào)用
/**
* props:
* @param {string} type - 顯示類型(可選): solid(default), dotted, dashed
* events:
* @event send-message - 發(fā)送信息(message)
* - @param {string} message - 返回信息
* methods:
* @function handleMessage - 信息相關(guān)處理
*/
export default {
data () {
return {
userName: '' // 用戶名稱
}
},
methods: {
init () { // 組件 UI 初始化 - 簡(jiǎn)單注釋
},
/**
* 保存用戶名稱
* @param {string} name - 保存名稱
*/
saveUserName (name) {
// ...
}
}
}
events list:
1) copypage-to
控制文件:@/views/edit/mixin/reportCatalog/reportCatalog.vue
-> @/views/edit/view/edit.vue
功能: 簡(jiǎn)報(bào)頁(yè)復(fù)制至 彈窗
3) 請(qǐng)求異常處理
1.請(qǐng)求 成功/失敗/異常 處理
this.$http.post(url, params).then(res => {
if (res.body.code === 0) {
// 成功處理
} else {
// 失敗處理
}
}).catch(err => {
// 異常處理
})
4) todo 格式
TODO: + 說(shuō)明：
如果代碼中有該標(biāo)識(shí)赶促，說(shuō)明在標(biāo)識(shí)處有功能代碼待編寫哼御，待實(shí)現(xiàn)的功能在說(shuō)明中會(huì)簡(jiǎn)略說(shuō)明。
FIXME: + 說(shuō)明：
如果代碼中有該標(biāo)識(shí)昌腰，說(shuō)明標(biāo)識(shí)處代碼需要修正举瑰，甚至代碼是錯(cuò)誤的，不能工作，需要修復(fù)，如何修正會(huì)在說(shuō)明中簡(jiǎn)略說(shuō)明曹步。
例子:
- 多行書寫
/**
* TODO:
* - ...
* - ...
*/
/**
* FIXME:
* - ...
* - ...
*/
- 單行書寫
// TODO: 描述
// FIXME: 描述
