多写注释提高代码可读性以及后期维护性,这些规范是用来要求自己的(仅此记录下)
项目目录结构
|--------dist/ // 打包目录
|--------doc/ // 项目文档
|--------public/ // 存放今天文件.(index.html文档/静态图片等打包会自动打包到dist目录中)
|--------src/ // 项目开发主目录
|-----------assets/ // 目录应用资源,通过require引入的资源.图片等
|-----------------css/ // 目录应用资源,样式
|-----------------images/ // 目录应用资源,图片
|-----------api/ // 网络请求处理
|-----------components/ // 公共组件库(里面不涉及接口和业务无关)
|-----------config/ // 项目公共配置文件
|-----------filters/ // 公共过滤器,可以没有
|-----------views/ // 视图
|---------------commom/ // 页面公共处理
|---------------components/ // 业务组件库 依赖项目的业务 里面可以存业务接口
|-----------router/ // 路由处理
|-----------store/ // 数据处理
|-----------utils/ // 公共方法
|--------.env/ // 项目公共处理变量.例如设置屏幕的最小最大尺寸等
|--------.env.dev/ // 根据不同场景设置不同变量
|--------.env.prod/ // 项目单元测试
|--------.babel.config.js/ // js转换处理
|--------.eslintrc.js/ // Eslint设置
项目命名
推荐项目/目录命名
全部采用小写方式,以下划线分割.例如: project_name
组件命名
组件命名用大驼峰. 例如: TodoItem.vue
视图文件命名
推荐用小驼峰. 例如: homeBar.vue
js文件/css/less/sass文件
使用下划线. 例如func_article.html
vue Template 命名
标签命名
一般使用中划线.例如: <home-bar></home-bar>
常量命名
使用全大写下划线. 例如: const MAX_PAGE_SIZE = 100
变量命名
使用小驼峰的方式,前面加上明确类型的使用类型前缀
javascript比变量类型 | 变量命名前缀 |
---|---|
Array | a |
Object | o |
String | s |
Number | n |
Boolean | b |
Function | f |
函数命名
使用小驼峰方式,明确类型,或者方法是用来做什么的,例如: addData(){} (增加数据等)