当前位置:首页 » 网页前端 » 公司前端开发规范
扩展阅读
webinf下怎么引入js 2023-08-31 21:54:13
堡垒机怎么打开web 2023-08-31 21:54:11

公司前端开发规范

发布时间: 2022-09-25 13:45:03

❶ Web前端开发规范之HTML规范

今天小编要跟大家分享的文章是关于Web前端开发规范之HTML规范。Web前端作为开发团队中不可或缺的一部分,需要按照相关规定进行合理编写(一部分不良习惯可能给自己和他人造成不必要的麻烦)。不同公司不同团队具有不同的规范和文档。下面是根据不同企业和团队的要求进行全面详细的整理结果。来和小编一起看一看HTML规范的原则吧!

HTML规范


1、文档类型声明及编码:统一为html5声明类型。书写时利用IDE实现层次分明的缩进(默认缩进4空格)。


2、非特殊情况下CSS文件放在body部分标签后。非特殊情况下大部分JS文件放在标签尾部(如果需要界面未加载前执行的代码可以放在head标签后)避免行内JS和CSS代码。


3、所有编码需要遵循html(XML)标准,标签&属性&属性命名必须由小写字母及下划线数字组成,且所有标签必须闭合,包括br(),hr()等。属性值用双引号。


4、引入JS库文件,文件名须包含库名称及版本号及是否为压缩版,比如jquery-1.4.1.min.js。引入插件,文件名格式为库名称+插件名称,比如jQuery.bootstrap.js。


5、书写页面过程中,请考虑向后扩展性。class&id参见css书写规范.


6、需要为html元素添加自定义属性的时候,首先要考虑下有没有默认的已有的合适标签去设置,如果没有,可以使用须以"data-"为前缀来添加自定义属性,避免使用"data:"等其他命名方式。


7、语义化html,如标题根据重要性用h*(同一页面只能有一个h1),段落标记用p,列表用ul,内联元素中不可嵌套块级元素。


8、尽可能减少div多层级嵌套。


9、书写链接地址时,必须避免重定向,例如:href="http://#/",即须在URL地址后面加上“/”;


10、在页面中尽量避免使用style属性,即style=""。


11、必须为含有描述性表单元素(input,textarea)添加label,如姓名:须写成:姓名:


12、能以背景形式呈现的图片,尽量写入css样式中。


13、重要图片必须加上alt属性。给重要的元素和截断的元素加上title。


14、给区块代码及重要功能(比如循环)加上注释,方便后台添加功能。


15、特殊符号使用:尽可能使用代码替代:比如<(<)&>(>)&空格()&_(_)等等。


以上就是小编今天为大家分享的关于Web前端开发规范之HTML规范的文章,希望本篇文章能够对正在从事Web前端工作的小伙伴们有所帮助,想要了解更多Web前端知识记得关注北大青鸟Web培训官网,最后祝愿小伙伴们工作顺利,成为一名优秀的Web前端工程师。


❷ Web前端开发规范之文件命名规范

今天小编要跟大家分享的文章是关于Web前端开发规范之文件命名规范。Web前端作为开发团队中不可或缺的一部分,需要按照相关规定进行合理编写(一部分不良习惯可能给自己和他人造成不必要的麻烦)。不同公司不同团队具有不同的规范和文档。下面是根据不同企业和团队的要求进行全面详细的整理结果。来和小编一起看一看文件命名规范的原则吧!

基本原则


符合Web标准(UTF-8,HTML5),语义化html(HTML5新增要求,减少div和span等无特定语义的标签使用),结构表现行为分离(HTML-CSS-JS代码分离,不同行为代码高内聚低耦合),兼容性优良(早期版本浏览器兼容,移动端和PC端设备兼容).页面性能方面(减少请求次数,例如使用精灵图和sass语法),代码要求简洁明了有序,尽可能的减小服务器负载,保证最快的解析速度(减小repaint和reflow).


文件命名规范


1、html,css,js,lib,images文件均存放至项目的目录中。如果使用相关前端框架,根据框架的文件格式进行合理布局。


2、所有文件夹及文件使用英文命名(避免使用中文路径)。


3、html文件:入口文件使用index.html。如果有对应的设计组设计原稿,需要将对应的设计稿和html文件命名一致并合理存放。


4、css文件命名:后缀.css。通用initial.css,初始化base.css,首页index.css,其他页面按照对应的html命名。


5、Js文件命名:英文命名,后缀.js.通用common.js,初始化base.js。其他页面按照对应的html命名。


以上就是小编今天为大家分享的关于Web前端开发规范之文件命名规范的文章,希望本篇文章能够对正在从事Web前端工作的小伙伴们有所帮助,想要了解更多Web前端知识记得关注北大青鸟Web培训官网,最后祝愿小伙伴们工作顺利,成为一名优秀的Web前端工程师。


❸ 前端开发实践中有哪些常见规范

Javascript编码规范
HTML编码规范
CSS编码规范
Less编码规范
E-JSON数据传输标准
模块和加载器规范
包结构规范
项目目录结构规范
图表库标准

❹ 前端开发实践中有哪些常见规范

Javascript编码规范
HTML编码规范
CSS编码规范
Less编码规范
E-JSON数据传输标准
模块和加载器规范
包结构规范
项目目录结构规范
图表库标准

❺ 前端开发实践中有哪些常见的规范

Javascript编码规范
HTML编码规范
CSS编码规范
Less编码规范
E-JSON数据传输标准
模块和加载器规范
包结构规范
项目目录结构规范
图表库标准

❻ 前端开发是做什么的工作职责有哪些

前端开发是做PC端开发任务;而Android开发、iOS开发和各种小程序主要针对的是移动端开发工作的。

1、使用Vue/React开发,配合产品完成 Web/Electron项目迭代;

2、收集、分析项目需求并给出技术解决方案,完成高质量的编码开发、调试和版本维护工作;

3、深入分析和解决前端遇到的各种技术、性能、跨终端兼容等问题,持续优化前端用户体验与框架;

4、协助前端开发工程体系建设与落地。

任职资格:

1、35周岁以下(含),211院校本科及以上学历,计算机相关专业优先,具备3年以上前端开发经验者优先;

2、掌握至少一种主流框架并深入了解其原理,熟悉前端研发生态圈,包括模块化、前端编译和构建工具;

3、熟悉主流浏览器的特点,对桌面跨平台有深入了解更佳;

4、有完整参与一个产品的设计、开发到上线过程,对前后端协作模式、产品和项目流程、网络和安全有深入理解,有大型项目前端架构部署和实践经验优先;

5、关注前沿技术,具备较强学习能力,在各大技术社区活跃者、有自己开源项目者优先;

6、具备良好服务意识、责任心以及团队沟通与协作能力。

❼ 什么是web前端开发标准

对于前端,官方的定义是网站前台部分,运行在PC端,移动端等浏览器上展现给用户浏览的网页。用自己的话来说,前端是网页给访问网站的人看的内容和页面,那前端开发顾名思义就是这些内容和页面中代码的实现。

现在的前端开发使得现代网页更加美观,交互效果显着,功能更加强大。所以现在的前端开发,运用到的知识面更加广泛,难度也更大。前端开发目前市场需求还是很大的,而且相对来讲比较容易,很适合学习。需要学习的内容也不少,我有全套web前端视频课资料可以发给你自学。

学习内容包括:

①计算机基础以及PS基础

②前端开发基础(HTML5开发、JavaScript基础到高级、jQuery网页特效、Bootstrap框架)

③移动开发

④前端高级开发(ECMAScript6、Veu.js框架开发、webpack、前端页面优化、React框架开发、AngularJS 2.0框架开发等)

⑤小程序开发

⑥全栈开发(MySQL数据库、Python编程语言、Django框架等)

⑦就业拓展(网站SEO与前端安全技术)

互联网行业目前还是最热门的行业之一,学习IT技能之后足够优秀是有机会进入腾讯、阿里、网易等互联网大厂高薪就业的,发展前景非常好,普通人也可以学习。

想要系统学习,你可以考察对比一下开设有相关专业的热门学校,好的学校拥有根据当下企业需求自主研发课程的能力,能够在校期间取得大专或本科学历,中博软件学院、南京课工场、南京北大青鸟等开设相关专业的学校都是不错的,建议实地考察对比一下。

祝你学有所成,望采纳。

❽ 前端项目的开发流程

前端开发流程概述

前端开发流程可分为需求分析、开发阶段、测试阶段、维护阶段,下面分别进行叙述。

2.1 需求分析

这个环节中,首先是和客户进行交流,了解客户的需求,然后分析项目的可行性,撰写项目需求文档。如果项目可行,则起讨论具体方案,分模块分步骤进行规划,分析项目进度安排、所需成本,进行原型设计(包括页面布局图,页面逻辑流程图,说明文档等。通过原型设计,可以让项目组和客户都可以对项目有一个直观感受,同时可以低成本高效率的复现业务场景和各模块流程)。
可以说需求分析阶段是整个前端项目的基础,基础不牢,地动山摇。可以试想,如果和客户沟通不顺畅,有的方面客户没搞清楚是什么效果,开发完成后就可能与客户发生纠纷;如果可行性有问题,有的模块很难实现或成本超出预算,就很难处理。

2.2 开发阶段

这个环节是前端工程师主要参与的部分,按照需求分析阶段的规划按步骤完成任务。

  • 根据产品需求分析文档和原型图进行UI设计,对产品的整体美术风格、交互设计、界面结构、操作流程等做出设计。负责项目中各种交互界面、图标、LOGO、按钮等相关元素的设计与制作。

  • 根据UI设计进行规划,提取界面中可以复用的模块方便重复利用,分析界面是否有实现难度比较困难的地方,进行沟通和功能排期,按功能大小以及难度进行功能时间的评估,和后端沟通好排期时间,保证大家能够更有效地开发合作,针对功能复杂的地方要先理清思路。

  • 不要盲目开发前端搭建框架。根据设计图进行前端界面开发,以及遇到的问题及时与产品、UI、后台人员沟通,保持大家信息一致,针对不清楚的地方也要及时沟通,以免做错功能。

  • 根据后端接口进行字段填充,以及部分功能开发。针对缺少的字段或者数据结构进行提出,及时与后端反应,尽量让大家都能以最小的改动完成后续开发工作。前后端都要按照规范进行开发,针对不规范的地方要给与提出、指正,营造出规范的工作模式,以后维护成本和沟通成本更低以及开发效率更高。如果前端的设计进度远远超前后端的接口和数据结构设计,也不必等后端,可以自行开发nodejs服务器配合postman等接口软件进行开发。

  • 前后端功能联调、完成自测。检查功能完成情况,看是否有遗漏,出现问题及时沟通解决。

  • 2.3 测试阶段

    发布测试、修改bug、发布上线,自测完成后提交测试,测试根据提交的项目以及需求进行测试,提出bug给相关人员修改,开发人员周期性的配合修改bug,保证今天能够修复昨天的bug。
    发布dev环境,配合测试,修复bug以及需求优化
    发布test环境,修复bug以及需求优化
    发布it环境,修复bug以及需求优化
    发布pre环境,修复bug以及需求优化
    pre验收之后,发布线上环境,产品进行验收

    2.4 维护阶段

    如果客户验收通过,项目就进入了维护阶段,程序的维护包括程序上线后后续bug的修复和程序版本的更新。

    3 个人经验总结

    3.1 文档很重要

    前端项目的文档似乎已经作为前端工程化的标准流程之一了,文档写的好,可以便于同事快速了解你的代码功能和需求,便于协作。可以想象,随之项目复杂度增加,体量越来越庞大,开发团队人数也越来越多。这种情况下,如果像变魔术一样隐匿中间流程而直接得出结果,后果可想而知:项目复杂度越增加就越难以管理,开发效率低,合作混乱,结果甚至导致项目死亡。
    好的文档看起来就像一个产品说明书,但作用却远远超过了说明书,不仅仅告诉你如何使用,还应该告诉你项目的设计思路,用了哪些组件,哪些部分不完善,将来有什么规划等等。这是一份比较好的说明文档。

    3.2 与客户及时沟通很重要

    3.3 扎实的基本功很重要

    尽管当下框架、函数库、工具包等更新迭代非常快,前端工程师有很多新的知识要学,但原生JS、HTML和CSS依然是重要的基本功,在学习前沿工具的同时不能放弃基本功的训练。

❾ 前后端接口对接规范(主要前端内容).md

前后端分离意味着,前后端之间使⽤ JSON 来交流,两个开发团队之间使⽤ API 作为契约进⾏交互。从此,后台选⽤的技术栈不影响前台。当我们决定需要前后端分离时,我们仍然还需要⾯对⼀系列的问题:

RESTful API 统一约束客户端和服务器之间的接口。简化和分离系统架构,使每个模块独立!

REST即表述性状态传递(英文:Representational State Transfer,简称REST)是Roy Fielding博士在2000年他的博士论文中提出来的一种 软件架构 风格。它是一种针对 网络应用 的设计和开发方式,可以降低开发的复杂性,提高系统的可伸缩性。 REST是设计风格而不是标准。 REST通常基于使用 HTTP ,URI,和 XML ( 标准通用标记语言 下的一个子集)以及 HTML (标准通用标记语言下的一个应用)

统一接口约束定义客户端和服务器之间的接口。它简化了分离的结构,使各部分独立发展。

REST要求状态要么被放入资源状态中,要么保存在客户端上。或者换句话说,服务器端不能保持除了单次请求之外的,任何与其通信的客户端的通信状态。 从客户端的每个请求要包含服务器所需要的所有信息。 这样做的最直接的理由就是可伸缩性—— 如果服务器需要保持客户端状态,那么大量的客户端交互会严重影响服务器的内存可用空间(footprint)。

服务器返回信息必须被标记是否可以缓存,如果缓存,客户端可能会重用之前的信息发送请求。

客户端无需关注数据存储,服务器端无需关注用户界面,提高了前后端可移植性。

客户端不关心直接连接到最终服务器还是连接到中间服务器。中间服务器可以通过启用负载平衡和提供共享缓存来提高系统可扩展性。分层系统也可以执行安全策略。

服务器可以通过传输逻辑来临时扩展或定制客户端的功能。

GET https//domain.com/api/{模块名}/{?菜单名}/{接口名}/:param

说明:

被用于获取资源。不允许对服务器上资源做任何修改操作。

示例:

常用于更新资源。通过请求体携带资源发送给服务器。 注意: 在资源ID由客户端而不是由服务器选择的情况下,也可以使用PUT来创建资源。修改成功返回200,创建成功返回201。 建议使用post进行创建新资源。

常用于创建新资源。创建成功通常返回201。

删除资源。

status说明

---------------------------------------------------------------------------分割线-----------------------------------------------------------

请求方式:POST

参数:说明

返回值:

示例1
正确的

错误的

❿ 前端规范一(命名规范)

前端规范一(命名规范)

1、小驼峰命名法(lowerCamelCase) :第一个单词以小写字母开始,第二个单词的首字母大写,例如:firstName、lastName。

2、大驼峰命名法(CamelCase) :每一个单词的首字母都采用大写字母,例如:FirstName、LastName。

3、下划线命名法(snake_case):下划线命名法也叫蛇形法,全由小写字母和下划线组成,在两个单词之间用下滑线连接。例如:first_name。

4、中划线命名法(kebab-case):中划线命名法也叫串式命名法,各个单词之间通过下划线“-”连接。例如:first-name。

强制使用:中划线命名法

命名规则:1、文件名不得含有空格

2、文件名建议只使用小写字母,不使用大写字母

3、文件名包含多个单词时,单词之间建议连词线 ( - ) 分隔

4、有复数结构式,要使用复数

示例:login 、 error-page、 icons

强制使用:全部大写字母

为了醒目,某些说明文件的文件名,可以使用大写字母

示例:README

补充说明: README 标准

◎ 项目简介。
◎ 注意事项。
◎ 线上的示例地址(测试、正式)。
◎ 支持运行的环境。
◎ 必要的依赖准备,以及如何搭建。
◎ 项目的安装指南。
◎ 相关的文档链接。
◎ 相关人员的联系方式。

README.md 示例:

强制使用:小驼峰命名法

命名规则:前缀为动词,见名知意

1、onXxx 监听事件的回调

2、handleXxx 处理事件

3、getXxx 获取某个值

4、setXxx 设置某个值

常见场景:

a、事件处理:

(1).事件主动监听采用 onXxx ,被动处理使用handleXxx

示例:onXxxSubmit: '提交表单'
handleXxxSizeChange: '处理分页页数改变'
handleXxxPageChange: '处理分页每页大小改变'
onXxxKeydown: '按下键'

(2). 其他命名:元素+click、 元素+change、select+范围

示例:selectAllXxx: '选择所有'
xxxCellClick: '当某个单元格被点击时会触发该事件'
xxxSortChange: '当表格的排序条件发生变化的时候会触发该事件'

b、增删改查处理:

增: addXxx 添加子项

createXxx 创建大项

删: deleteXxx 真删除

removeXxx 伪删除

改:updateXxx

查: getXxx 获取原始数据需要修改

fetchXxx 原始数据

示例:getUserList: '获取用户列表', fetchToken: '取得Token', deleteUser: '删除用户', removeTag: '移除标签', updateUserInfo: '更新用户信息', addUser: '添加用户', createAccount: '创建账户'

c、API接口函数:

get: getXxxApi

post: postXxxApi

patch: patchXxxApi

delect: delectXxxApi

域名:xxxUrl

一般属性变量 强制使用:小驼峰命名法

1、布尔值

命名规则:前缀为判断性动词

hasXxx 判断是否含有某个值。true:含有此值; false:不含有此值

isXxx 判断是否为某个值。true:为某个值; false:不为某个值

示例:isShow: '是否显示', isLoading: '是否处于加载中', hasToken: '是否包含Token',

2、数组命名

命名规则:使用名词+List组合

示例: userList: '用户列表'

3、私有属性变量

命名规则:前缀为下划线(_)后面和变量命名一样。

4、枚举变量 \textcolor{red}{强制使用:大驼峰命名法}

枚举的属性使用全大写字母,单词间用下划线隔开。

示例:let TargetState = { READING: 1, READED: 2, APPLIED: 3, READY: 4 };

5、常量: 强制使用:使用全大写字母,单词间用下划线隔开

强制使用:大驼峰命名法

命名规则: 可参考vue官网风格指南

例如: 1、按照功能来命名

2、应用特定样式和约定的基础组件 (也就是展示类的、无逻辑的或无状态的组件) 应该全部以一个特定的前缀开头,比如 Base、App 或 V。

3、组件名应该以高级别的 (通常是一般化描述的) 单词开头,以描述性的修饰词结尾。

示例:components/
|- BaseButton.vue
|- BaseTable.vue
|- BaseIcon.vue

强制使用: 中划线命名法

命名规则:

1.class、id 、标签、属性的命名应该尽量精短、明确,必须以字母开头命名,且全部字母为小写,单词之间统一使用中划线 “-” 连接

2.class必须代表相应模块或部件的内容或功能,不得以样式信息进行命名。

3.元素 id 必须保证页面唯一。

4.禁止创建无样式信息的 class

示例:

1、尽量不要缩写、简写的单词。除了 template => tmp、message => msg、image => img、property => prop 这些单词已经被公认的缩写

2、可读性强的命名优先于简短的命名

3、命名长度最好在 20 个字符以内,避免多长带来的阅读不便

4、命名要有具体的含义,避免使用一些泛指和无具体含义的词

5、不要使用拼音,更不要使用中文

6、正则表达式用 Exp 结尾

7、ref:使用Ref结尾