2023-09-30 14:02:38 | 我爱编程网
开发规范(前端)
版本: v1.0
日期: 2022-01-15
一:命名规范
命名统一使用英文单词,要求简单,通俗易懂。
项目命名
使用小写字母,多单词采用 “ - ” 中划线拼接。
例如:my-world / world
文件夹命名
使用小写字母,多单词采用 “ - ” 中划线拼接。
例如:home-page / home
文件命名
使用小写字母,多单词采用 “ - ” 中划线拼接。 我爱编程网
例如:home-page / home
变量命名
使用小驼峰命名。如果单文件中变量过多,可能会出现重名的情况,建议增加前缀来区分不同功能的变量。或者把变量拆分到不同的文件之中。
例如:maxHeight / userMaxHeight / homeMaxHeight
常量命名
全部使用大写字母。多单词采用 “ _ ” 下划线隔开。
例如:const USER_TYPE = “9001”;
函数命名
规范一:使用小驼峰命名。被继承的父类的私有函数需要增加下划线前缀 “ _getPrice() ”。
例如:showToast / _getPrice
规范二:根据函数作用,适当添加动词前缀。
例如:getSize / setSize / hasNumber
前缀请查看文档最底部 “ 附件一:(函数命名动词前缀整合) ”
二:注释规范
简单易懂的变量方法,尽量编写注释。复杂难懂的变量方法,必须编写注释
单行注释 //
在代码上一行编写单行注释,简单介绍下方代码用途、注意事项等内容。
多行注释 /* */ 或 /** */
方法必须使用多行注释。当变量或代码块复杂,单行注释不足以解释清楚的时候,也需要使用多行注释。
例如:
// 商品名称
goodsName: '猕猴桃',
/**
* 传入人员姓名,从数据库中查询该人员的手机号码
* @param {String} userName 姓名
* @return {Number} 手机号
*/
getUserMobile(userName){
......
return mobile;
},
三:CSS规范
1. class类名使用小写字母,多单词采用 “ - ” 中划线拼接。
2. id采用小驼峰命名。
3. scss、less中变量、函数、mixin统一采用小驼峰命名。
4. 缩进整洁有序。
四:项目规范
项目结构建议规范(实际根据具体需求逻辑进行调整)
src
api 所有接口封装
asstes 资源文件
- images 图片
- videos
components 所有组件
router 路由
store 状态管理
styles 公共样式
utils 公共函数库
view 视图
- home 视图文件需要分模块分文件夹存放
home.vue
home-detail.view
- user
五:附件
附件一:(函数命名动词前缀整合)
以上就是我爱编程网小编给大家带来的web前端开发命名规范参考 div+CSS的命名规则?,希望能对大家有所帮助。Web前端工程师要知道的JavaScript变量命名规范今天小编要跟大家分享的文章是关于Web前端工程师要知道的JavaScript变量命名规范,正在从事Web前端工作的小伙伴们来和小编一起看一看吧,希望本篇文章能够对大家有所帮助。JavaScript变量命名规范:只能由英语字母、数字、下划线、美元符号$构成,且不能以数字开头,并且不能是JavaScript保留字。下列
web编程开发模块化的理解与规范?随着web前端编程开发技术的不断发展,模块化编程开发形式成为了目前程序员学习的主流开发方式,下面IT培训就一起来来了关于模块化的理解以及开发规范问题。一、模块化的理解1.什么是模块?将一个复杂的程序依据一定的规则(规范)封装成几个块(文件),并进行组合在一起块的内部数据与实现是私有的,只是向外部暴露一些接口(方法)与外部其它模块通信
web前端开发基础要学哪些内容?要学的内容有:1、Web前端开发语言、HTML超文本标记语言、网页主体结构、常用标签、超链接(a标签)、Img图片标签;2、初探Div盒子模型、css样式、简单css样式、盒子模型Border边框讲解、盒子模型外边距盒子模型内边距、盒子模型占位计算、ul无序列表、ol有序列表、dl定义列表、补充知识(css);3、样式初始化、元素类型转换、内联
web前端开发基础要学哪些内容?要学的内容有:1、Web前端开发语言、HTML超文本标记语言、网页主体结构、常用标签、超链接(a标签)、Img图片标签;2、初探Div盒子模型、css样式、简单css样式、盒子模型Border边框讲解、盒子模型外边距盒子模型内边距、盒子模型占位计算、ul无序列表、ol有序列表、dl定义列表、补充知识(css);3、样式初始化、元素类型转换、内联
前端开发个人简历范文参考撰写个人简历是前端开发个人求职者求职的第一步,也是前端开发个人求职者求职的必备文件。下面是我整理的前端开发简历范文,以供大家阅读。前端开发简历范文(一)个人概况姓名:*****出生年月:1992-1性别:男身高:171CM婚姻状况:未婚籍贯:福建莆田市政治面貌:共青团员目前所在地:义乌稠州北路601号求职意
Web前端工程师应该知道的CSS隐藏页面元素的方法今天小编要跟大家分享的文章是关于Web前端工程师应该知道的CSS隐藏页面元素的方法。用CSS隐藏页面元素有许多种方法。你可以将opacity设为0、将visibility设为hidden、将display设为none或者将position设为absolute然后将位置设到不可见区域。你有没有想过,为什么我们要有这么多技术
web前端三大主流框架Web前端三大框架:Vue.js、React.js、Angular.js。1、Vue.jsVuejs的受欢迎度目前是最高的,而开发vuejs的就是一个中国人名字叫尤雨溪。Vue可以通过简洁的API提供高效的数据绑定和灵活的组件系统。同时,尤雨溪选择了开源的方式,方便更多的开发者使用并参与其中。Vue也使用虚拟DOM,因此在项目中的更改不会正式对
关于php的命名空间的问题PHP命名空间(namespace)是在PHP5.3中加入的,如果你学过C#和Java,那命名空间就不算什么新事物。不过在PHP当中还是有着相当重要的意义。PHP命名空间可以解决以下两类问题:用户编写的代码与PHP内部的类/函数/常量或第三方类/函数/常量之间的名字冲突。为很长的标识符名称(通常是为了缓解第一类问题而定义的)创建一个别名(或简短)的名称,
2023-10-08 16:59:01
2023-06-27 20:13:22
2023-10-17 00:15:33
2023-10-17 00:13:37
2023-10-17 00:04:47
2023-10-17 00:03:25