|
一、结构化规范
(一)目录文件夹及文件规范
以下统一管理处均对应相应模块
以下全局文件文件均以 index.js 导出，并在 main.js 中导入
以下临时文件，在使用后，接口已经有了，发版后清除
src 源码目录
|-- api 接口，统一管理
|-- assets 静态资源，统一管理
|-- components 公共组件
|-- filters 过滤器，全局工具
|-- icons 图标
|-- datas 模拟数据，临时存放
|-- lib 外部引用的插件存放及文件修改
|-- mock 模拟接口，临时存放
|-- router 路由
|-- store vuex
|-- views/pages 视图目录
|-- home 视图模块名
|-- home.vue 模块入口文件
|-- components 模块通用组件文件夹
|-- constants.js 全局常量存放
README.md 项目说明
复制代码
二、注释规范
代码注释在一个项目的后期维护中显的尤为重要，所以我们要为每一个被复用的组件编写组件使用说明，为组件中每一个方法编写方法说明
(一)务必添加注释列表
公共组件使用说明
各组件中重要函数或者类说明
复杂的业务逻辑处理说明
特殊情况的代码处理说明,对于代码中特殊用途的变量、存在临界值、函数中使用的 hack、使用了某种算法或思路等需要进行注释描述
多重 if 判断语句
注释块必须以/**（至少两个星号）开头**/
单行注释使用//
(二)单行注释
注释单独一行，不要在代码后的同一行内加注释。例如：
bad
let name = "abc" // 姓名
good
// 姓名
let name = "abc"
复制代码
(三)多行注释
/**
* 组件名称
* @module 组件存放位置
* @desc 组件描述
* @author 组件作者
* @date 2017年12月05日17:22:43
* @param (Object] [title]-参数说明
* @param {String} [columns] - 参数说明
* @example 调用示例
* |