加入文件注释

BoBoooooo · Jan 20, 2019 · 132cdf3 · 132cdf3
1 parent 617fcf5
commit 132cdf3
Show file tree

Hide file tree

Showing 20 changed files with 120 additions and 8 deletions.
diff --git a/src/icons/index.js b/src/icons/index.js
@@ -1,3 +1,8 @@
+/*
+ * @Author: BoBo
+ * @Date: 2018-12-25 18:33:50
+ * @Description: 全局注册svg-icon组件
+ */
 import Vue from 'vue'
 import SvgIcon from '@/components/SvgIcon/index.vue';
 

diff --git a/src/main.js b/src/main.js
@@ -3,6 +3,9 @@
  * @Date: 2018-12-22 16:25:54
  * @Last Modified by:   BoBo
  * @Last Modified time: 2018-12-22 16:25:54
+ * @Description
+ * 入口文件，初始化了全局Vue实例
+ * 全局插件以及组件的注册需写在main.js中
  */
 
 /* eslint-disable no-new */

diff --git a/src/permission.js b/src/permission.js
@@ -3,6 +3,8 @@
  * @Date: 2018-12-23 10:58:07
  * @Last Modified by:   BoBo
  * @Last Modified time: 2018-12-23 10:58:07
+ * @Description
+ * 登录鉴权js,获取当前用户token身份信息以及所拥有的路由权限
  */
 import router from './router';
 import store from './store';

diff --git a/src/router/index.js b/src/router/index.js
@@ -1,3 +1,15 @@
+/*
+ * @Author: BoBo
+ * @Date: 2018-12-21 14:35:39
+ * @Description:
+ * 前端路由，均为路由懒加载
+ *
+ * noDropDown 表示只渲染一级菜单，无下拉效果
+ * hidden 隐藏指定路由，不渲染在菜单列表中
+ * icon 配置父级菜单图标
+ * noCache 不开启页面缓存
+ *
+ */
 import Vue from 'vue'
 import Router from 'vue-router'
 import Layout from '../views/layout/Layout'

diff --git a/src/store/getters.js b/src/store/getters.js
@@ -1,13 +1,21 @@
+/*
+ * @Author: BoBo
+ * @Date: 2018-12-21 14:34:50
+ * @Description: 全局vuex getter
+ *
+ * 调用时，在相应的vue中，imoprt该js
+ * this.getters.token 即可获取
+ */
 const getters = {
   sidebar: state => state.app.sidebar,
   token: state => state.user.token,
   // avatar: state => state.user.avatar,
   visitedViews: state => state.tagsView.visitedViews,
   cachedViews: state => state.tagsView.cachedViews,
-  realname:state=>state.user.realname,
+  realname: state => state.user.realname,
   name: state => state.user.name,
   addRouters: state => state.permission.addRouters,
-  routers:state=>state.permission.routers
+  routers: state => state.permission.routers,
 
 }
 export default getters
diff --git a/src/store/index.js b/src/store/index.js
@@ -1,3 +1,8 @@
+/*
+ * @Author: BoBo
+ * @Date: 2018-12-21 14:34:50
+ * @Description: 全局vuex
+ */
 import Vue from 'vue'
 import Vuex from 'vuex'
 import app from './modules/app'
@@ -10,13 +15,13 @@ import getters from './getters'
 Vue.use(Vuex)
 
 const store = new Vuex.Store({
-   modules: {
-           app,
+  modules: {
+    app,
     user,
     permission,
-    tagsView
+    tagsView,
   },
-  getters
+  getters,
 })
 
 export default store
diff --git a/src/store/modules/app.js b/src/store/modules/app.js
@@ -1,3 +1,8 @@
+/*
+ * @Author: BoBo
+ * @Date: 2018-12-21 14:34:50
+ * @Description: 侧边栏收缩状态存储
+ */
 import Cookies from 'js-cookie'
 
 const app = {

diff --git a/src/store/modules/permission.js b/src/store/modules/permission.js
@@ -1,3 +1,8 @@
+/*
+ * @Author: BoBo
+ * @Date: 2018-12-21 14:34:50
+ * @Description: 鉴权路由处理以及存储
+ */
 import {
   asyncRouterMap,
   constantRouterMap,

diff --git a/src/store/modules/tagsView.js b/src/store/modules/tagsView.js
@@ -1,3 +1,8 @@
+/*
+ * @Author: BoBo
+ * @Date: 2018-12-21 14:34:50
+ * @Description: tab数组存储
+ */
 const tagsView = {
   state: {
     visitedViews: [],

diff --git a/src/store/modules/user.js b/src/store/modules/user.js
@@ -1,3 +1,9 @@
+/*
+ * @Author: BoBo
+ * @Date: 2018-12-21 14:34:50
+ * @Description: 登录，登出，修改密码，获取用户信息
+ * 存储的变量有当前用户token,用户名以及昵称
+ */
 import {
   login,
   logout,

diff --git a/src/styles/element-ui.scss b/src/styles/element-ui.scss
@@ -1,4 +1,9 @@
- //覆盖一些element-ui样式
+/*
+ * @Author: BoBo
+ * @Date: 2018-12-21 14:34:50
+ * @Description: 覆盖一些element-ui样式
+ */
+
 
  .login-container{
   .el-input__inner{

diff --git a/src/styles/index.scss b/src/styles/index.scss
@@ -1,3 +1,8 @@
+/*
+ * @Author: BoBo
+ * @Date: 2018-12-21 14:34:50
+ * @Description: 全局样式
+ */
 @import './variables.scss';
 @import './mixin.scss';
 @import './transition.scss';

diff --git a/src/styles/layout.scss b/src/styles/layout.scss
@@ -1,3 +1,8 @@
+/*
+ * @Author: BoBo
+ * @Date: 2018-12-21 14:34:50
+ * @Description: web整体布局样式
+ */
 #app {
   @import "src/styles/mixin.scss";
   .app-wrapper {

diff --git a/src/styles/transition.scss b/src/styles/transition.scss
@@ -1,4 +1,9 @@
-//globl transition css
+/*
+ * @Author: BoBo
+ * @Date: 2018-12-21 14:34:50
+ * @Description: globl transition css
+ */
+
 
 /*fade*/
 .fade-enter-active,

diff --git a/src/styles/variables.scss b/src/styles/variables.scss
@@ -1,3 +1,9 @@
+/*
+ * @Author: BoBo
+ * @Date: 2018-12-21 14:34:50
+ * @Description: 预设的全局color 
+ * 使用时@import该css即可
+ */
 $blue:#324157;
 $light-blue:#3A71A8;
 $red:#C03639;

diff --git a/src/utils/auth.js b/src/utils/auth.js
@@ -1,3 +1,8 @@
+/*
+ * @Author: BoBo
+ * @Date: 2018-12-21 14:33:55
+ * @Description:全局token
+ */
 import Cookies from 'js-cookie'
 
 const TokenKey = 'Admin-Token'

diff --git a/src/utils/download.js b/src/utils/download.js
@@ -1,3 +1,8 @@
+/*
+ * @Author: BoBo
+ * @Date: 2018-12-21 14:33:55
+ * @Description: 文件下载函数
+ */
 import axios from 'axios'
 import {
   getToken,

diff --git a/src/utils/fetch.js b/src/utils/fetch.js
@@ -1,3 +1,10 @@
+/*
+ * @Author: BoBo
+ * @Date: 2018-12-25 18:33:50
+ * @Description:
+ * 全局axios配置
+ * 配有req以及res两个拦截器
+ */
 import axios from 'axios'
 import {
   Message,

diff --git a/src/utils/index.js b/src/utils/index.js
@@ -1,3 +1,9 @@
+/*
+ * @Author: BoBo
+ * @Date: 2018-12-21 14:33:55
+ * @Description: 工具函数
+ */
+
 
 export function parseTime(time, cFormat) {
   if (arguments.length === 0) {

diff --git a/src/utils/validate.js b/src/utils/validate.js
@@ -1,3 +1,10 @@
+/*
+ * @Author: BoBo
+ * @Date: 2018-12-21 14:33:55
+ * @Description: 正则校验以及大小写转换函数
+ */
+
+
 /* 合法uri */
 export function validateURL(textval) {
   const urlregex = /^(https?|ftp):\/\/([a-zA-Z0-9.-]+(:[a-zA-Z0-9.&%$-]+)*@)*((25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9][0-9]?)(\.(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])){3}|([a-zA-Z0-9-]+\.)*[a-zA-Z0-9-]+\.(com|edu|gov|int|mil|net|org|biz|arpa|info|name|pro|aero|coop|museum|[a-zA-Z]{2}))(:[0-9]+)*(\/($|[a-zA-Z0-9.,?'\\+&%$#=~_-]+))*$/