前端开发规范总结

网友投稿 618 2022-05-30

制定相关的开发规范,是为了约束开发人员编写的代码保持一致风格,提高代码可读性,提高团队协作效率,以便于前端后期的代码优化维护和维护人员添加功能, 最终保证输出可读性强和可维护的代码和高质量的文档。

项目结构规范

前端开发规范总结

project --项目名称 assets css --样式文件 js --存放javaScript脚本 images --图片文件 api --请求接口 bin --二进制文件 components --公共组件 config --配置文件 local cn --中文资源文件 en --英文资源文件 utils --存放工具类文件 views --页面文件 temp --存放临时文件资源 mock --模拟接口数据 data --数据文件

文件命名规范

文件名统一用小写的英文字母、数字和下划线的组合,其中不能包含汉字、空格和特殊字符。

命名原则思想:

1.使自己和工作组的每一个成员能够理解每一个文件的意义;

2.当我们在文件夹中使用“按名称排例”的规则,同一种大类的文件能够排列在一起,以便我们查找、修改、替换、计算负载量等操作。

Html 命名

主页文件命名统一使用 index.htm,index.html,index.asp,index.asp 等文件名(小写)。

子页命名的原则首先应该以栏目名的英语翻译取单一单词为名称。例如: 关于我们(aboutus) 管理页面(manager) 订单(order)产 品(product ) 等。

Javascript 命名

弹出窗口(pop.js), 请求(request.js),全局(global.js),api接口(api.js),权限(auth.js),存储(storage.js)等。

图片命名

图片的名称分为头尾两部分,用下划线隔开,头部分表示此图片的大类性质,尾部表示此图片二级类型。

如:轮播图(banner),标志性(logo),按钮(button),菜单(menu),导航(nav),地图(map),头部(head),底部(bottom)等。

主次如:share_sina.jpg,share_qq,share_baidu,banner_qq.gif,banner_sohu.gif,menu_product.gif,menu_job.gif 等。

CSS 命名规范

CSS样式可细分为3类:自定义样式、重新定义HTML样式、链接状态样式。

1. 自定义新的 CSS 样式,影响被使用本样式的区域,用于设定网页中局部的样式。

自定义样式名 “.”+“相应样式效果描述的单词或缩写”,例:“ .shadow ”;

文字样式名 “.no”+“字号”+“行距”+“颜色缩写”,例:“ .no12 ” 、“ .no12-24 ”;

2. 重新定义已有的HTML标签样式,影响全部的被设定标签样式,用于统一网页中某一标签的样式定义。

标签样式名 “HTML标签”,例:hr { border: 1px dotted #333333 }

3. 对链接不同状态设定特殊样式,影响被使用本样式区域中的链接。

只能修饰标签: a.nav:link{ ... }

修饰所有包含有标签的其他标签:nav.a:link{ ... }

页面样式引用方式

页头:header 页脚:footer 导航:nav 子导航:subnav 侧栏:sidebar 栏目:column 内容:content/container 左右中:left right center 登录:login 标志:logo 广告图:banner 页面主体:main 新闻:news 下载:download 菜单:menu 子菜单:submenu 搜索:search 版权:copyright 滚动:scroll 内容:content 标签页:tab 列表:list 提示:msg 标题:title

HTML 命名规范

- 网页 head 标签内的规范

网页显示字符集 :

网页简介:

网页标题: 网页标题内容

引入外部 css 文件:

引入外部 js 文件:

2.react的封装

封装react共有三步:

(1)创建虚拟DOM对象;创建对象包含有3个参数,标签名、属性(对象格式)、标签内的内容;

(2)获取挂载点;

(3)渲染页面。

格式如下:

此封装过程也可用JSX语法来写:

可以看出,JSX语法最大区别在于省去了创建虚拟DON对象的步骤,而是直接创建一个标签对象,在该标签对象中直接按照HTML格式书写代码即可,其余两步则不变。

二、组件

组件,从概念上类似于 JavaScript 函数。它接受任意的入参(即 “props”),并返回用于描述页面展示内容的 React 元素。React 定义组件有两种方式:

函数方式,rfc react function component;某些不能使用;

类方式,rcc react class component;功能更为强大;

1.函数方式定义组件

2.函数组件传参

3.类方式定义组件

4.类组件传参