前端vue3项目规范及命名规范

1.代码量

单个文件:单个文件原则上代码量不超过500行,超过则考虑拆分或抽取组件;

单个函数:单个方法不超过80行,超过则需考虑抽取子函数;

请求:请求放在单独的文件里(后缀api.js),然后引入;

页面数据:页面配置数据(如表格搜索栏,表头字段)放在单独的文件里(后缀data.js),然后引入;

2.多个特性的元素规范

多个特性的元素应该分多行撰写,每个特性一行,增强可读性。

例如:<my-component

              foo="a"

              bar="b"

              baz="c"

           >

         </my-component>

3.普通变量命名规范

小驼峰命名法,如mySchool,命名必须是跟需求内容有关的词,命名是复数的时候需要加s。

4.常量命名规范

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

5.组件命名规范

声明组件:单词首字母大写命名,如MyComponent,组件名应该始终是多个单词,根组件App除外。组件名应该是有意义的、简短、具有可读性。

使用组件:短横线分割命名,如<my-component></my-component>

6.方法命名规范

驼峰式命名,统一使用动词+名词形式,如getTemplateList()

7.文件夹命名规范

文件夹代表模块的名字,一般直接由页面中文名称翻译为英文名称。

文件夹英文名称第一个单词的字母小写,后面每个单词的首字母大写。

views文件夹下,只有一个文件的情况下不需要创建新的子文件夹,而是直接放在views目录下。

8.css命名规范

class命名采用小写字母,以中划线分割

id命名采用驼峰命名

Scss中的函数、变量等使用驼峰命名

  • 7
    点赞
  • 5
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
前端vue项目设计规范是指在开发vue项目时应当遵循一定的规范和标准,以确保项目代码结构清晰、逻辑合理、易于维护和拓展。 首先,在项目的文件结构上,应当按照功能和模块进行组织,将相关的文件放在同一个文件夹中,保持目录结构清晰,便于团队成员共同协作。 其次,在编码风格上,应当遵循一定的规范,例如使用ES6语法、遵循统一的缩进规则、合理的命名规范等,以提高代码的可读性和维护性。 在组件的设计上,应当尽量将复杂的界面拆分为小的、独立的组件,使得每个组件的功能单一、结构清晰,提高组件的复用性和可维护性。 在数据管理上,应当合理使用vuex来管理应用的状态,在设计数据流动时,应当遵循单向数据流的原则,通过actions和mutations来操作数据,以便于追踪数据的变化和管理。 在路由设计上,应当按照模块和功能进行路由的拆分,并且合理使用路由守卫来进行权限控制,保证页面的安全性和合理性。 另外,在对接后端接口时,应当建立统一的接口管理规范,包括接口命名规范、参数规范、错误码规范,以提高团队协作的效率和规范性。 总之,前端vue项目设计规范是为了提高项目的可维护性、可拓展性和团队协作效率,我们应当在开发过程中严格遵循这些规范,以确保项目的质量和稳定性。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值