代码规范

一、变量命名规范

1、Vue 响应式对象命名

ref响应式对象:xxxRef
reactive响应式对象: xxxReactive
ref响应式元素:xxxElRef

// 普通对象
const userInfo = {
  name: '张三',
  age: 18
}

// 响应式对象:ref和reactive
// 如果是ref,规范为:xxxRef。
const nameRef = ref('李四');
// 如果是reactive,xxxReac
const userInfoReac = reactive({
  name: '张三',
  age: 18
})

// 如果是元素,xxxElRef。 El是为了区分和上面的Ref区别
// html 代码
<div ref="divElRef"></div>
// js代码
const divElRef = ref(null);

2、类型修饰后缀

// 序号采用index,整数采用num,浮点型采用float
let rowIndex = 1;        // 行顺序号
let docNum = 155;        // 稿件数量
let lengthFloat = 89.5;    // 长度通常是整
数型的,加上float作为后缀后,就明确了变量的实际类型

// 字符串采用str,布尔型采用'is'作为前缀
const sex = 1;
const sexStr = ['女', '男', '未知'][sex];
const isMen = sex == 1;

// 数组采用array,集合采用set/map,对象采用obj,JSON采用json
const userObj = {};
const userJson = {};
const userArray = [];    // 不建议采用list作为后缀
const userSet = new Set();
const userMap = new Map();

// 类和函数修饰后缀
const xxxFn;            // 函数
const xxxCb;            // 回调函数(强调:为了避免回调'cb'与采编'cb'的命名歧义,系统中用全大写'CB'代表采

2、UI组件中加载或弹窗控制规范

// 只有一个loading
<a-table :loading="loading" />
// 有多个loading
<a-table :loading="loading" />
<a-table :loading="loadingUserTable" />
<a-table :loading="loadingRoleTable" />

// visible同上

三、Vue 模板中方法名规范

// 提交:handleSubmit或handleSubmitXxx
<a-button type="primary">提交</a-button>

// 保存:handleSave或handleSaveXxx
<a-button type="primary" @click="handleSave">保存</a-button>

// 关闭:handleClose或handleCloseXxx
<a-button type="primary" @click="handleClose">关闭</a-button>

// 打开弹窗:openDialog或openDialogXxx
<a-button type="primary" @click="openDialog">打开弹窗</a-button>

// 关闭弹窗:closeDialog或closeDialogXxx
<a-button type="primary" @click="closeDialog">关闭弹窗</a-button>

// 跳转页面: jump或jumpXxx
<a-button type="primary" @click="jump">跳转页面</a-button>

三、类和类中方法的命名规范 强制

1 类名采用大驼峰方式命名,实例名采用小驼峰方式命名
2 类中方法采用小驼峰方式命名
3 内部方法名前面加下划线,表示私有方法仅限内部调用
4 以上命名方式同样适用于对构造函数及内部方法的命名

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,793评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,567评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,342评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,825评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,814评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,680评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,033评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,687评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 42,175评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,668评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,775评论 1 332
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,419评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,020评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,978评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,206评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,092评论 2 351
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,510评论 2 343

推荐阅读更多精彩内容

  • iOS代码规范总结 一些原则 长的,描述性的方法和变量命名是好的。不要使用简写,除非是一些大家都知道的场景比如 V...
    ElegantLiar阅读 1,590评论 0 17
  • -------------------------------------编码原则----------------...
    yanhooIT阅读 824评论 0 11
  • 一、编程规约 (一)命名规范 1.1.1 项目命名 全部采用小写方式, 以中划线分隔。 1.1.2 目录命名 全部...
    Xincol阅读 214评论 0 0
  • 1、命名规范 1.1 统一要求 含义清楚,尽量添加注释, 使用全称,不使用缩写 1.2 类的命名 大驼峰式命名:每...
    yuanweiphone阅读 405评论 0 0
  • [TOC] 前言 这份文档是Google Java编程风格规范的完整定义。当且仅当一个Java源文件符合此文档中的...
    marine8888阅读 1,940评论 0 1