工匠智造文档

Vue通用开发规范

命名规范

  1. 枚举名:大驼峰,并且以Enum结尾,value:值,text:多语key(小驼峰,如果多语包没有key值,则按普通文本处理),remark:备注

    RoundType: {
        RoundByValue: { value: 0, text: 'roundByValue', remark: '按值舍入' },
        AllAdd: { value: 1, text: 'allAdd', remark: '全部进位' },
        AllDelete: { value: 2, text: 'allDelete', remark: '全部舍位' }
    }
  2. 变量名:小驼峰

  3. 布尔变量:尽量以 is 开头

  4. 方法名:采用小驼峰形式

  5. 事件名:尽量以 on 开头,小驼峰形式

约束

  1. 代码格式: 严格按照顺序来写,便于维护
import Pkg from 'pkg';

export default {
    name: '',
    mixins: [],
    props: {
        // ...
    },
    data: function() {
        return {
            // ...
        }
    },
    watch: {
        variable: {
            handler() {
                // ...
            }
        }
    },
    computed: {
        variable: {
            get: function() {
                // ...
            }
        }
    },
    methods: {
        onBtnClick() {
            // ...
        },
        method1(){
            // ...
        },
        // ...
    },

    beforeCreate() {
        // ...
    },
    created(){
        // ...
    },
    beforeMount(){
        // ...
    },
    mounted(){
        // ...
    },
    beforeUpdate(){
        // ...
    },
    updated(){
        // ...
    },
    beforeDestroy(){
        // ...
    },
    destroyed(){
        // ...
    }
}