学习了一段时间的vue,总结一下Vue书写规范

  • 命名规范
    • 普通变量命名规范
    • 常量命名规范
    • 组件命名规范
    • method 方法命名命名规范
    • views 下的文件命名
    • props 命名规范
  • 结构化规范

命名规范

在团体开发项目中,为了团队所有成员书写可维护的代码,而不是一次性的代码,让团队当中其他人看你的代码能一目了然,甚至过一段时间时候后你再回来看你自己某个时候写的代码也能看明白,所以命名很重要的。

普通变量命名规范

命名方法 :驼峰命名法
命名规范 :

命名必须是跟需求的内容相关的词,比如说我想申明一个变量,用来表示我的学校,那么我们可以这样定义 constmySchool=“我的学校”;
命名是复数的时候需要加s,比如说我想申明一个数组,表示很多人的名字,那么我们可以这样定义 constnames=newArray();

常量命名规范

命名方法 : 全部大写
命名规范 :

使用大写字母和下划线来组合命名,下划线用以分割单词。

 const MAX_COUNT = 10const URL = 'https://www.csdn.net/

组件命名规范

官方文档推荐及使用遵循规则:

PascalCase (单词首字母大写命名)是最通用的声明约定
kebab-case (短横线分隔命名) 是最通用的使用约定
组件名应该始终是多个单词的,根组件 App 除外

有意义的名词、简短、具有可读性,命名遵循 PascalCase 约定
公用组件以 Abcd (公司名缩写简称) 开头,如( AbcdDatePicker,AbcdTable)
页面内部组件以组件模块名简写为开头,Item 为结尾,如( StaffBenchToChargeItem,StaffBenchAppNotArrItem)使用遵循 kebab-case 约定

在页面中使用组件需要前后闭合,并以短线分隔,如( ,),导入及注册组件时,遵循 PascalCase 约定,同时还需要注意:必须符合自定义元素规范: 切勿使用保留字。

method 方法命名命名规范

驼峰式命名,统一使用动词或者动词+名词形式

//bad
go、nextPage、show、open、login
// good
jumpPage、openCarInfoDialog
请求数据方法,以 data 结尾//bad
takeData、confirmData、getList、postForm
// good
getListData、postFormData
init、refresh 单词除外

尽量使用常用单词开头(set、get、go、can、has、is)
附: 函数方法常用的动词:

get 获取/set 设置,
add 增加/remove 删除
create 创建/destory 移除
start 启动/stop 停止
open 打开/close 关闭,
read 读取/write 写入
load 载入/save 保存,
create 创建/destroy 销毁
begin 开始/end 结束,
backup 备份/restore 恢复
import 导入/export 导出,
split 分割/merge 合并
inject 注入/extract 提取,
attach 附着/detach 脱离
bind 绑定/separate 分离,
view 查看/browse 浏览
edit 编辑/modify 修改,
select 选取/mark 标记
copy 复制/paste 粘贴,
undo 撤销/redo 重做
insert 插入/delete 移除,
add 加入/append 添加
clean 清理/clear 清除,
index 索引/sort 排序
find 查找/search 搜索,
increase 增加/decrease 减少
play 播放/pause 暂停,
launch 启动/run 运行
compile 编译/execute 执行,
debug 调试/trace 跟踪
observe 观察/listen 监听,
build 构建/publish 发布
input 输入/output 输出,
encode 编码/decode 解码
encrypt 加密/decrypt 解密,
compress 压缩/decompress 解压缩
pack 打包/unpack 解包,
parse 解析/emit 生成
connect 连接/disconnect 断开,
send 发送/receive 接收
download 下载/upload 上传,
refresh 刷新/synchronize 同步
update 更新/revert 复原,
lock 锁定/unlock 解锁
check out 签出/check in 签入,
submit 提交/commit 交付
push 推/pull 拉,
expand 展开/collapse 折叠
begin 起始/end 结束,
start 开始/finish 完成
enter 进入/exit 退出,
abort 放弃/quit 离开
obsolete 废弃/depreciate 废旧,
collect 收集/aggregate 聚集

views 下的文件命名

只有一个文件的情况下不会出现文件夹,而是直接放在 views 目录下面,如 index.vue
尽量是名词,且使用驼峰命名法。

开头的单词就是所属模块名字(workbenchIndex、workbenchList、workbenchEdit)
名字至少两个单词(good: workbenchIndex)(bad:workbench)

props 命名规范

在声明 prop 的时候,其命名应该始终使用 camelCase,而在模板中应该始终使用
kebab-case

例外情况
作用域不大临时变量可以简写,比如:str,num,bol,obj,fun,arr。
循环变量可以简写,比如:i,j,k 等。

结构化规范

目录文件夹及子文件规范

以下统一管理处均对应相应模块
以下全局文件文件均以 index.js 导出,并在 main.js 中导入
以下临时文件,在使用后,接口已经有了,发版后清除

src 源码目录

|-- api 接口,统一管理
|-- assets 静态资源,统一管理
|-- components 公用组件,全局文件
|-- filters 过滤器,全局工具
|-- icons 图标,全局资源
|-- datas 模拟数据,临时存放
|-- lib 外部引用的插件存放及修改文件
|-- mock 模拟接口,临时存放
|-- router 路由,统一管理
|-- store vuex, 统一管理
|-- views 视图目录
| |-- staffWorkbench 视图模块名
| |-- |-- staffWorkbench.vue 模块入口页面
| |-- |-- indexComponents 模块页面级组件文件夹
| |-- |-- components 模块通用组件文件夹

以上是vue项目中的 文件基本结构,都是这样组成的。规范的命名和基本的文件结构方便我们更好的理代码和维护代码。

【前端】1.学习了一段时间的vue,总结一下Vue书写规范相关推荐

  1. python忠告_学习Python一段时间,老司机给上路新手的3点忠告!

    在你学习编程的过程中,是否有过以下经历,或正在面临类似的局面:网上找了很多资料,不知道从哪里看起 买了本书,过了很久也没有看完第一章 开始还能跟着写几行代码,后来突然就看不懂了 也看了些教程和视频,似 ...

  2. 欧洲语言框架A1到C2,开言英语怎么样,学习过一段时间的效果评价

    随着国际化的发展,很多企业都要求员工能够熟练的掌握一门外语,但是我们大多数人从学校毕业出来,都对英语这门课程掌握的不是很熟练,特别是开口说英语,所以很多人都想着报班学习英语,而现在学习英语的方式有很多 ...

  3. Web 前端开发学习资料整理

    以前学习过一段时间的web前端开发,整理了一些我看过的/我认为比较好的学习资料(网站.书籍).我只是闲来无事整理一下,如有不足,嘴下留情..毕竟分享不是一件坏事,共同学习... 一. 语言基础(以书和 ...

  4. 2022年前端工程师学习路线

    ` 标题:前端工程师学习路线 路线:HTML=>CSS=>JS=>JQ=>bootstrap=>Vue.js,React,Angularjs=>node.js 1. ...

  5. 老铁是要塞里最出名的铁匠大师,小铁是老铁的儿子,老铁希望小铁能传承他的衣钵为要塞的骑士们锻造护甲。经近一段时间的学习,小铁逐渐掌握了打铁的技术,但是他很快发现,每一天手臂的力量总是不如前一天

    老铁是要塞里最出名的铁匠大师,小铁是老铁的儿子,老铁希望小铁能传承他的衣钵为要塞的骑士们锻造护甲.经近一段时间的学习,小铁逐渐掌握了打铁的技术,但是他很快发现,每一天手臂 的力量总是不如前一天,粗略估 ...

  6. 前端岗位初入职场后的最初一段时间需要做什么

    文章题目有点长,叫 <前端岗位初入职场后的最初一段时间需要做什么>,说下写这篇文的初衷,在前端自学团里有很多刚毕业或者是刚从培训班出来的同学,在群里天天讨论着找工作和面试的事情,面试的题在 ...

  7. 对这段时间学习数据库的总结和感悟

    对这段时间学习数据库的总结和感悟 从2018-12月开始学习mysql,到今天,已经一个月了,因为上班的关系,所以只能每天挤时间出来学习mysql,因为之前一直是使用oracle数据库,所以我也没顾得 ...

  8. 前端入门 前端自学路线 web开发前端如何学习

    本文介绍前端入门之路,以及之后对前端应该怎么学,大概学哪些东西.作者在前端.后端入门的时候,花了大量时间到CSDN.知乎.百度上去找资料,但是有的说的不是太复杂, 就是一句话带过,那个时候很苦恼.现在 ...

  9. 裸辞后,从Android转战Web前端的学习以及求职之路

    在互联网的下半场,想要通过开发出一个APP就去创业,几乎不可能,难的不是开发成本,而是运营成本. 前言 我从Android开发转Web前端开发,没有别的原因,纯粹只是因为兴趣.你所见到的网站开发.手机 ...

最新文章

  1. IDEA 快捷键 (长期更新)
  2. 网络测试及故障诊断方法及工具
  3. JVM--字节码执行引擎
  4. Python 中类的继承:属性初始化、类型判断、多态、多继承和对象信息的获取
  5. python作者 google面试_如果Google面试让你用python写一个树的遍历程序
  6. 计算机硬件知识考证题,2017年计算机硬件知识考试题及答案
  7. 专家观点:Docker 架构优缺点大剖析
  8. c语言的关键字及其作用,c语言关键字及其含义 详细归纳
  9. 贝壳基于 Flink 的实时计算演进之路
  10. InfoPath 教程
  11. 外研在线:如何用云技术优化教育服务
  12. 跟我学Spring3-开涛-笔记
  13. spacy 英文模型下载_英语文本处理工具库2 — spaCy
  14. SharePoint专家新闻轮转器WebPart----亲测力推之Web部件
  15. 文件包含漏洞——实例
  16. 计算机截图工具无法运行,重装win7系统后打开截图工具显示“截图工具当前未在计算机上运行”如何解决...
  17. 字符编码(ASCII,Unicode和UTF-8) 和 大小端
  18. 经典排序算法-----归并排序(C语言实现)
  19. 教师资格证面试 计算机应用,2017年初中信息技术教师资格证面试真题及答案(第四批)...
  20. 幼儿园观察记录的目的和目标_幼儿园观察记录:如何让幼儿在区角活动中真正动起来...

热门文章

  1. 5.execve()到底干了啥?
  2. 基于Matlab的BiLSTM实现
  3. kindeditor在线编辑器的使用心得
  4. 这些渐行渐远的友情,你有过吗?
  5. 【MODIS合集】MRT批处理MODIS数据
  6. 计算机音乐数字乐谱贴吧,【图片】【谱集】贴吧谱子整理【计算器音乐吧】_百度贴吧...
  7. 计算机的未来发展趋势
  8. 华盛顿与李大学教授出版的这本数据结构书,是国外高等院校优秀教材
  9. Excel通过ODBC连接MySQL
  10. nslookup命令反解ip_PING、TRACERT、NSLOOKUP命令的使用方法