寫(xiě)代碼之前請(qǐng)先看看開(kāi)發(fā)文檔規(guī)范
1. 組件與樣式寫(xiě)在一個(gè)目錄里面,方便后面移動(dòng)
layout
layout.vue
layout.less
2. 每一個(gè)組件都有自己的使用文檔說(shuō)明
組件屬性,方法說(shuō)明
3. 每一個(gè)方法都有自己的使用說(shuō)明 安裝 jsdoc 選中所寫(xiě)函, 按下 ctrl+shift+p, 選中 gen jsdoc
/**
* 描述
* @author ken
* @date 2021-05-19
* @returns {any}
*/
showLoading() {
this.$loading.show({ tip: "3 秒后自動(dòng)隱藏" });
setTimeout(() => {
this.$loading.hide();
}, 3000);
},
4. src/api 用于存放所有接口
命名注意見(jiàn)名知道意思
user.js
order.js
5. src/assets 用于存放圖片
img
logo.svg
6. src/components 用于存放所有公共的組件,組件獨(dú)立于自己的文件內(nèi)
// 只有一個(gè)組件的形式
GlobalFooter
src
index.vue
index.js // 用于導(dǎo)出組件
// 多個(gè)組件的形式
RightContent
src
AvatarDropdown.vue
RightContent.vue
index.js // 用于統(tǒng)一導(dǎo)出組件
7. src/config 用于存放一些靜態(tài)的配置,以 .config.js 結(jié)尾
router.config.js
theme.config.js
8. src/core 存放一些指令,
directive
click.dir.js
9. src/layouts 存放各個(gè)組件顯示的 layout 模板
layouts
BasicLayout.vue
StoreLayout.vue
BlankLayout.vue
10. src/locales 存放多語(yǔ)言
en-us
xxx.js
zh-cn
xxx.js
11. src/plugin 用于存放一些三方插件,自定義的插件
// 第三方插件
12. src/router 用于存放路由
router
index.js
13. src/store 用于存放 vuex
store
index.js
14. src/styles 用于存放一些全局的通用的樣式
global.less //全局樣式
vars.less // 變量定義
color.less // 顏色值變量定義
15. src/utils 用于存放一些公用的工具方法,像拷貝方法,去重方法
copyObj.util.js
16. src/views 用于存放頁(yè)面顯示的模板
store
StoreList.vue
18. 每一個(gè)三方插件必須有對(duì)應(yīng)的文檔鏈接,或者基本的使用方法說(shuō)明
比如:本項(xiàng)目用到 store 這個(gè)三方插件,請(qǐng)把鏈接貼出來(lái)
19. 比如 eslint 一些規(guī)范問(wèn)題,在提交代碼之前,請(qǐng)使用以下命令,檢測(cè)是否有警告,或者錯(cuò)誤,或者定義的變量沒(méi)有使用,一定要處理掉,不要把這些警告,錯(cuò)誤提交上 github
npm run lint
Vue standard - 代碼規(guī)范
Vue standard - 代碼規(guī)范

評(píng)論
圖片
表情
