代码规范

1、css规范

命名一般为小写英文字母
为了代码的易读性,在每个声明块的左花括号前添加一个空格
所有声明语句都应当以分号结尾。最后一条声明语句后面的分号是可选的,但是,如果省略这个分号,你的代码可能更易出错
对于属性值或颜色参数,省略小于 1 的小数前面的 0 (例如,.5 代替 0.5;-.5px 代替 -0.5px)
十六进制值应该全部小写,例如:#fff
尽量使用简写形式的十六进制值,例如:用 #fff 代替 #ffffff
避免为 0 值指定单位,例如,用 margin: 0; 代替 margin: 0px
2、js规范(eslint)

3、组件研发规范

1、数据流

数据从父组件流入,子组件尽量不要修改数据,通过emit通知父组件修改数据
如果子组件为数据修改器,可以通过v-model形式修改传入数据
尽量在父组件获取源数据,传入子组件
不要过度依赖vuex,影响组件独立性和迁移性
2、封装原则

单个组件功能要单一,多功能应该抽离多个组件
提炼工具模块,尽量避免组件内包含业务逻辑
合理添加slot,提供多场景的dom灵活性
3、注意事项

尽量避免使用过多watch操作,对于大数据,watch性能消耗明显
props传参对于对象或数组类型要给到初始值,避免访问属性时报错
业务组件层级深度尽量不要超过3级,避免数据追踪困难
4、命名规范

1、组件

文件名命名:edit-table.vue 或 com-card.vue(单名前面拼接com)
使用命名:<edit-table></edit-table>
2、页面路由文件

文件夹命名:小驼峰 如 index.vue fontPage.vue
3、props :驼峰

4、data:驼峰

5、watch:驼峰

6、接口:驼峰

7、方法:驼峰

8、vuex

state: 驼峰
getters: 驼峰
mutations: 大写下划线 例如:SET_NAME
actions: 驼峰
5、约定命名(如果没必要,不要分业务场景语义化)

1、data

主体数据:(表格:datas;表单:form;数组类:datas;对象类:data)
状态类:后面拼接State,(显示隐藏:showState;限制标记:limitState;计数状态:numState等等)
类型:后面拼接Type,(使用类型:useType;按钮类型:btnType等等)
2、方法

初始化数据:init (如果不需要依赖dom渲染在created生命周期调用)
组件修改数据:change(例如el-input,el-select等,或者自研组件,数据变更emit)
获取数据:getXXX
设置数据:setXXX
更改按钮:update
编辑按钮:edit
删除按钮:del
保存按钮:save
取消按钮:cancel
6、代码注释

props
watch
data
接口
方法
接口、方法注释采用多行注释:

  /**

   * 描述

   * @param data 入参描述
   */

   props、watch、data用单行注释:

  // 注释描述
©著作权归作者所有,转载或内容合作请联系作者
【社区内容提示】社区部分内容疑似由AI辅助生成,浏览时请结合常识与多方信息审慎甄别。
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。
禁止转载,如需转载请通过简信或评论联系作者。

推荐阅读更多精彩内容

  • 前端开发规范 一、HTML1.语义化标签HTML5 提供了很多语义化元素,更好地帮助描述内容。希望你能从这些丰富的...
    木子士心呦阅读 3,342评论 0 0
  • 一、前端编辑器 vscode 对angular、typescript有着非常友好的支持,轻便快捷,代码统一,一键格...
    ElliottsSu阅读 4,525评论 0 2
  • 一、基本规则描述 1、变量命名、函数: a、变量命名语义化; b、不能使用拼音; c、函数的命名建议动词开头; 2...
    来了啊小老弟阅读 1,468评论 0 0
  • 本文转载于Blankj/AndroidStandardDevelop: :star2: Best practice...
    杨晓是大V阅读 4,415评论 0 1
  • 前言 虽然我们项目的代码时间并不长,也没经过太多人手,但代码的规范性依然堪忧,目前存在较多的比较自由的「代码规范」...
    Android小码阅读 3,885评论 0 0

友情链接更多精彩内容