前端开发规范文档
前端代码规范文档
前端代码规范文档前端代码规范文档一、命名规范1. HTML/CSS命名规范- 使用小写字母和连字符（-）作为单词分隔符；- 尽量避免使用缩写，除非是广泛接受的缩写；- 使用有意义的命名，不使用无意义的命名；- 使用统一的命名方式来表示特殊类型的元素（例如：头部、侧边栏等）；2. JavaScript命名规范- 使用驼峰命名法（camelCase）；- 使用有意义的命名来描述变量、函数或类的作用；- 避免使用单个字符的命名，除非是临时变量；- 使用全大写的命名方式来表示常量；二、缩进和空格规范1. 使用4个空格来进行缩进；2. 在括号前后留一个空格；3. 在运算符前后留一个空格；4. 在函数名和参数列表之间留一个空格；三、注释规范1. 使用注释来解释代码的功能和用途；2. 对于复杂的代码块或关键算法，应提供详细的注释；3. 注释应该是清晰明了的，避免使用不恰当的术语或缩写；4. 重要的注释可以使用大写字母或星号来标记；四、代码风格规范1. 使用一致的缩进和空格；2. 合理使用换行符，避免一行代码过长；3. 尽量避免使用行尾的空格或制表符；4. 使用一致的括号风格，例如在函数或语句块的开头和结尾都使用大括号；5. 使用分号来结束语句；6. 使用合理的命名方式来描述变量、函数和类的作用；7. 避免使用全局变量，使用局部变量或封装变量的方式来控制变量的作用范围；8. 避免使用多层嵌套的条件语句，可以使用条件判断的方法来简化代码；9. 使用恰当的函数和类来封装可重用的代码；五、代码结构规范1. 尽量避免大而复杂的函数，使用小而简单的函数来实现功能；2. 模块化代码，将相关联的函数和类放在同一个文件中；3. 合理使用空行来分隔不同的代码块；4. 将页面的结构和样式分离开来，使得HTML文件更加简洁和易于维护；5. 对于重要的功能块，使用代码块注释来标记开头和结尾；六、代码审查规范1. 对新提交的代码进行审查，确保其符合代码规范；2. 对代码中的错误和潜在问题进行识别和修复；3. 鼓励团队成员进行代码审查和互相学习，提高代码质量；4. 定期审核项目中的代码，找出不符合规范的代码并进行修正。
前端规范手册
前端开发规范手册一、规范目的1.1 概述.....................................................................................................................................。
1二、文件规范2.1一般规范 (1)2.2 css 书写规范 (2)2.3 html书写规范 (6)2.4 JavaScript书写规范 (10)一、规范目的1.1 概述为提高团队协作效率, 便于前端后期优化维护, 输出高质量的代码, 特制订此文档. 本规范文档一经确认, 前端开发人员必须按本文档规范进行前台页面开发.二、文件规范2.1 一般规范以下章节列举了一些可应用在 HTML, JavaScript 和 CSS 上的通用规则。
2.2.1文件/资源命名文件名称统一用并且只能用小写的英文字母、数字或下划线的组合，其中不得包含汉字、空格和特殊字符，文件命名需要基本符合语意化；命名原则的指导思想一是使得你自己和工作组的每一个成员能够方便的理解每一个文件的意义，二是当我们在文件夹中使用“按名称排例”的命令时，同一种大类的文件能够排列在一起，以便我们查找、修改、替换、计算负载量等等操作。
所有的文件名应该都遵循同一命名约定2.2.2文件/资源命名一次缩进两个空格。
推荐2.2.3文件/资源命名注释是你自己与你的小伙伴们了解代码写法和目的的唯一途径。
特别是在写一些看似琐碎的无关紧要的代码时，由于记忆点不深刻，注释就变得尤为重要了。
编写自解释代码只是一个传说，没有任何代码是可以完全自解释的。
而代码注释，则是永远也不嫌多。
1.html注释: 注释格式<!--这儿是注释-->, '--'只能在注释的始末位置,不可置入注释文字区域;2.css注释: 注释格式/*这儿是注释*/;3.JavaScript注释, 单行注释使用'//这儿是单行注释' ,多行注释使用/* 这儿有多行注释*/;2.2.4文件/资源命名公共文件需放到public公共包，对应的文件放到对应于css，js，images文件夹中2.2.5关注点分离这里的关注点主要指的是：信息（HTML 结构）、外观（CSS）和行为（JavaScript）。
WEB前端开发规范方案文档
WEB前端开发规范方案文档一、概述本文档旨在规范前端开发团队的开发流程和编码规范，以提高代码的可读性、可维护性和可扩展性。
本规范适用于Web前端开发工作，包括HTML，CSS和JavaScript等相关技术。
二、项目目录规范1.项目根目录下应包含以下文件或文件夹：- index.html：项目的入口文件；- css文件夹：存放项目的css文件；- js文件夹：存放项目的JavaScript文件；- images文件夹：存放项目的图片文件；- fonts文件夹：存放项目的字体文件；- libs文件夹：存放项目的第三方库文件；- README.md：项目的说明文档。
2.CSS文件命名规范- 使用小写字母和中划线来命名文件，如：main.css；- 使用语义化的名称来命名文件，如：reset.css；- 对于一些通用的样式文件，可以使用常见的名称，如：normalize.css。
3. JavaScript文件命名规范- 使用驼峰命名法来命名文件，如：app.js；- 使用语义化的名称来命名文件，如：utils.js；- 对于一些通用的JavaScript文件，可以使用常见的名称，如：jquery.js。
三、HTML规范2.缩进和换行- 使用两个空格的缩进来表示嵌套关系，不使用tab键；3.属性顺序- 属性应按照以下顺序书写：class、id、data-*、style、src、href、alt、title等。
四、CSS规范1.样式命名规范- 使用小写字母和中划线来命名样式，如：header-title；- 使用语义化的名称来命名样式，如：main-container；-避免使用缩写，提高代码的可读性和可维护性。
2.CSS选择器规范- 使用类选择器来选中元素，不使用id选择器，以免造成样式的耦合性和难以维护性；-避免使用通配符选择器；-避免使用嵌套选择器，以免造成样式的复杂性和性能问题。
3.代码注释规范-使用注释来说明代码的用途和作用；-使用块注释来注释一整段代码，使用行注释来注释一行代码。
WEB前端开发规范文档
WEB前端开发规范文档目录WEB前端开发规范文档 (1)规范目的 (2)基本准则 (2)文件规范 (2)html书写规范 (2)html其他规范 (3)css书写规范 (4)JavaScript书写规范 (5)jQuery部分 (5)开发及测试工具约定 (6)其他规范 (6)规范目的为提高团队协作效率, 便于后台人员添加功能及前端后期优化维护, 输出高质量的文档, 特制订此文档: 本规范文档一经确认, 前端开发人员必须按本文档规范进行前台页面开发: 本文档如有不对或者不合适的地方请及时提出, 经讨论决定后方可更改:基本准则1：符合web标准, 语义化html,遵循内容（HTML）、显示（CSS）、行为（JavaScript）分离的代码组织模式。
2：代码格式化，保持干净整洁。
3：换行必须缩进一个tab。
4：编写所有前台页面时，请使用已有模板进行复制，在模板的基础上进行开发。
5：每一个页面都必须有一个独立的css，js文件。
6：如果不是用HTML5编写的网站，请用IE7，IE8，IE9，火狐，谷歌，webkit，safari内核进行测试兼容性。
7：如果是HTML5编写的网站，请用IE9，火狐，谷歌，webkit，safari内核进行测试兼容性。
文件规范1: html, css, js, images文件均归档至<系统开发规范>约定的目录中;2: html文件命名: 英文命名, 后缀:htm: 同时将对应界面稿放于同目录中, 若界面稿命名为中文, 请重命名与html文件同名, 以方便后端添加功能时查找对应页面;3: css文件命名: 英文命名, 后缀:css: 共用base:css, 首页index:css, 其他页面依实际模块需求命名:;4: Js文件命名: 英文命名, 后缀:js: 共用common:js, 其他依实际模块需求命名:html书写规范1：所有元素都必须小写，属性也是，如： <input type=”text”id=”idName”/>正确<INPUT TYPE=”text”ID=”idName”/>错误2：元素必须成对出现，如<span>必须写成<span></span>特殊元素除外，如：<br /><hr /><img /><input />3：标签中不允许出现样式，必须用class来声明样式，如：<input type=”text”id=”idName”style=”text-align:right;”/>错误<input type=”text”id=”idName”class=”class-name”/>正确4：元素id命名必须是驼峰式命名如：<input type=”text”id=”idName”/>正确<input type=”text”id=”idname”/>错误<input type=”text”id=”id-name”/>错误5：元素class命名规范是：元素简写+”-”+功能名，如：<button calss=”btn-save”></button>正确<button calss=”btnSave”></button>错误<button calss=”save”></button>错误6：元素name命名必须遵循驼峰式命名法。
Web前端开发规范手册
Web前端开发规范手册一、规范目的1.1 概述 1二、文件规范2.1 文件命名规则 (1)2.2 文件存放位置22.3 css 书写规范32.4 html书写规范72.5 JavaScript书写规范112.6 图片规范122.7 注释规范132.8 css 浏览器兼容13一、规范目的1.1 概述为提高团队协作效率, 便于后台人员添加功能及前端后期优化维护, 输出高质量的文档, 特制订此文档. 本规范文档一经确认, 前端开发人员必须按本文档规范进行前台页面开发. 本文档如有不对或者不合适的地方请及时提出, 经讨论决定后可以更改此文档.二、文件规范2.1 文件命名规则文件名称统一用小写的英文字母、数字和下划线的组合，其中不得包含汉字、空格和特殊字符；命名原则的指导思想一是使得你自己和工作组的每一个成员能够方便的理解每一个文件的意义，二是当我们在文件夹中使用“按名称排例”的命令时，同一种大类的文件能够排列在一起，以便我们查找、修改、替换、计算负载量等等操作。
a. HTML的命名原则引文件统一使用index.htm index.html index.asp文件名（小写）各子页命名的原则首先应该以栏目名的英语翻译取单一单词为名称。
例如：关于我们\ aboutus信息反馈\ feedback产品\ product如果栏目名称多而复杂并不好以英文单词命名，则统一使用该栏目名称拼音或拼音的首字母表示；每一个目录中应该包含一个缺省的html 文件，文件名统一用index.htm index.html index.asp；b. 图片的命名原则图片的名称分为头尾两部分，用下划线隔开，头部分表示此图片的大类性质例如：广告、标志、菜单、按钮等等。
放置在页面顶部的广告、装饰图案等长方形的图片取名：banner标志性的图片取名为：logo在页面上位置不固定并且带有链接的小图片我们取名为button在页面上某一个位置连续出现，性质相同的链接栏目的图片我们取名：menu装饰用的照片我们取名：pic不带链接表示标题的图片我们取名：title范例：banner_sohu.gif banner_sina.gif menu_aboutus.gif menu_job.gif title_news.gif logo_police.gif logo_national.gif pic_people.jpg鼠标感应效果图片命名规范为"图片名+_+on/off"。
前端开发规范文档
前端开发规范文档一、概述。
本文档旨在规范前端开发工作，统一团队成员的开发风格，提高代码质量和可维护性。
在前端开发中，规范是非常重要的，它可以让团队成员之间的合作更加顺畅，代码更加易读易懂。
本规范文档将涵盖HTML、CSS、JavaScript等前端开发的相关规范，希望每位开发人员都能认真遵守。
二、HTML规范。
1. 文件命名规范。
文件名应使用小写字母，单词之间可以使用连字符“-”连接，例如，index.html、about-us.html。
文件名应简洁明了，不使用无意义的数字或字符。
2. 代码缩进规范。
使用两个空格进行代码缩进，不使用Tab键。
3. 标签规范。
标签名应使用小写字母。
标签属性值应使用双引号。
4. 注释规范。
在需要注释的地方使用<!--->进行注释。
5. 其他规范。
应尽量避免使用行内样式和行内脚本。
尽量减少标签的嵌套层级，保持HTML结构的简洁性。
三、CSS规范。
1. 文件组织规范。
将CSS文件统一放置在一个文件夹中，不要将CSS文件散落在各个目录中。
可以根据模块或页面的不同，将CSS文件拆分为多个文件，使用@import进行引入。
2. 类名规范。
类名应使用小写字母，单词之间可以使用连字符“-”连接，例如，header-nav、footer-content。
类名应简洁明了，不使用无意义的数字或字符。
3. 属性顺序规范。
CSS属性应按照一定的顺序书写，例如，布局定位属性、盒模型属性、文字排版属性、视觉效果属性等。
4. 其他规范。
尽量避免使用!important，除非必要情况下。
尽量使用缩写属性，减少代码量。
四、JavaScript规范。
1. 变量命名规范。
变量名应使用驼峰命名法，例如，myName、isShow。
变量名应简洁明了，不使用无意义的单个字母。
2. 代码缩进规范。
使用两个空格进行代码缩进，不使用Tab键。
3. 注释规范。
在需要注释的地方使用//进行单行注释，使用/ /进行多行注释。
前端开发设计规范文档
前端开发设计规范文档一、引言二、代码编写规范1.缩进和空格-使用2个空格作为一个缩进层级。
- 在每个关键词或运算符后添加一个空格，如if (condition) {}。
-每行代码的末尾都应该去掉多余的空格。
2.行长限制每行代码应控制在80个字符以内，避免过长的代码行导致代码难以阅读和理解。
3.注释-使用注释来解释代码的意图和逻辑。
-使用单行注释（//）来注释一行代码，使用多行注释（/*...*/）来注释一段代码。
-注释要保持与代码同步，当代码发生修改时，注释也应随之更新。
4.变量和函数命名- 使用驼峰命名法（camelCase）命名变量和函数。
变量和函数名应该清晰明确，能够准确表达其含义。
-避免使用缩写和简写，除非是常见的缩写或简写形式。
5.常量命名-使用全大写字母和下划线的命名方式命名常量。
-常量名要具有描述性，能够清晰表达其含义。
6.字符串引号-使用双引号（""）包裹字符串，避免使用单引号（''）。
7.条件判断和循环语句-在条件判断和循环语句中使用花括号（{}）包裹代码块，即使只有一行代码。
8.数据类型转换-使用严格相等运算符（===）进行数据类型和值的比较，避免使用弱相等运算符（==）。
三、组织结构规范1.文件和文件夹命名-文件和文件夹命名应该清晰明确，能够准确表达其内容。
-文件和文件夹的命名应使用小写字母、短划线和数字的组合，避免使用空格和特殊字符。
2.目录结构前端项目应该按照一定的目录结构进行组织，常见的目录结构如下：- src：项目源代码目录。
- assets：用于存放静态资源文件，如图片、字体等。
- styles：存放样式文件。
- scripts：存放脚本文件。
- pages：存放页面组件。
四、性能优化规范1.文件合并和压缩-将多个CSS和JS文件合并为一个文件，并进行压缩。
-使用工具和插件进行自动化合并和压缩操作。
2.图片优化- 使用适当的图像格式，如JPEG、PNG、WebP等，以提高图像加载速度。
前端开发规范文档
前端开发规范文档规范目的为提高团队协作效率，便于后端开发人员添加功能及前端后期优化维护，输出高质量的代码，特制定该文档。
本规范文档一经确认, 前端开发人员必须按本文档规范进行前端开发。
本文档如有不对或者不合适的地方请及时提出。
经讨论决定后方可更改。
基本准则符合web标准，语义化html，结构表现行为分离，兼容性优良。
页面性能方面，代码要求简洁明了有序，尽可能的减小服务器负载，保证最快的解析速度。
一、html 文件命名及编写规范1、命名规则采用小写英文字母|| _的组合命名，菜单名_功能名称，后缀.html。
如：manage_list.html（管理列表）、manage_add.html（新增）、manage_edit.html（修改）、manage_detail.html（详情）。
同时将页面放在其对应的模块划分目录中。
2、编写规范：(1)文档类型声明及编码统一为html5声明类型“<!DOCTYPE html>”;(2)编码统一为<meta charset="utf-8" />, 书写时利用IDE实现层次分明的缩进;(3)区域块、功能组件以及需要标注的地方，插入注释。
(4)在布局文件结构时，应遵循语义化标签（该用p不要用div、该用ul、li不要用p，h标签应根据标题层级合理利用）、代码结构简单、清晰明了，少用标签、少套结构（一段结构布局中 1个标签能解决的不要用2个，套2层结构能解决的不要套3层）的基本原则。
代码标签、结构嵌套示例：目标效果图代码结构嵌套<ul><li><h4>罗田县九资河徐冲药材</h4><img src=”***.jpg”><div><h3>茯苓</h3><p>小丁</p><p class=”color_red”>32元/公斤</p></div></li></ul>代码分析：根据目标效果图，实现的代码部分别使用了ul/li /h4/ img /div /h3/ p 这些标签。
- 1、下载文档前请自行甄别文档内容的完整性，平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益，请联系客服反馈,我们会尽快为您处理(人工客服工作时间：9:00-18:30)。
前端开发规范文档
规范目的
为提高团队协作效率，便于后端开发人员添加功能及前端后期优化维护，输出高质量的代码，特制定该文档。
本规范文档一经确认, 前端开发人员必须按本文档规范进行前端开发。
本文档如有不对或者不合适的地方请及时提出。
经讨论决定后方可更改。
基本准则
符合web标准，语义化html，结构表现行为分离，兼容性优良。
页面性能方面，代码要求简洁明了有序，尽可能的减小服务器负载，保证最快的解析速度。
一、html 文件命名及编写规范
1、命名规则
采用小写英文字母|| _的组合命名，菜单名_功能名称，后缀.html。
如：manage_list.html（管理列表）、manage_add.html（新增）、manage_edit.html（修改）、manage_detail.html（详情）。
同时将页面放在其对应的模块划分目录中。
2、编写规范：
(1)文档类型声明及编码统一为html5声明类型“<!DOCTYPE html>”;
(2)编码统一为<meta charset="utf-8" />, 书写时利用IDE实现层次分明的缩进;
(3)区域块、功能组件以及需要标注的地方，插入注释。
(4)在布局文件结构时，应遵循语义化标签（该用p不要用div、该用ul、li不要用p，
h标签应根据标题层级合理利用）、代码结构简单、清晰明了，少用标签、少套结构（一段结构布局中 1个标签能解决的不要用2个，套2层结构能解决的不要套3层）的基本原则。
代码标签、结构嵌套示例：
目标效果图代码结构嵌套
<ul>
<li>
<h4>罗田县九资河徐冲药材</h4>
<img src=”***.jpg”>
<div>
<h3>茯苓</h3>
<p>小丁</p>
<p class=”color_red”>32元/公斤</p>
</div>
</li>
</ul>
代码分析：根据目标效果图，实现的代码部分别使用了ul/li /h4/ img /div /h3/ p 这些标签。
首先这是一个产品列表，所以用了ul li进行包裹；其次，这块分别有两个重要的内容展示，一个是产品名称，一个是企名称，根据权重，代码层分别采用了h3、h4标签；
其它的文字展示信息采用了p标签；图片采用标签img引入。
整个实现，代码结构清晰、标签使用合理，符合语义化、遵循SEO搜索等原则。
二、CSS文件命名及编写规范
1、命名规则
用小写英文字母命名（可跟据CSS作用域以及、区域模块、公用组件、等等分别命名），
后缀.css。
如：common.css（公用）、reset.css（重置）、base.css（页面主体）、form.css （表单）、popup.css（弹层）等等。
2、编写规范：
(1)除重置样式使用元素选择器（html\body\div\p\ul\li……）外，其它原则上使用类
选择器（.nav\.header……）编写样式，如无特别需要，应避免使用ID选择器（#btn\#foot……）；
(2)编写格式：为提高样式代码的可读性、方便开发人员查找、维护，因此采用单行编写
格式，一行编写一个属性和属性值。
如果一个类选择器属性只有2到3个，考虑到节省空间问题，可不换行在同行编写；
(3)区域块、组件及需要标注的地方请插入注释。
(4)样式命名：采用“小写英文(模块、组件及功能名称)”+“ _(拼接)”+“--(修饰符)”
规则命名。
如：“toggle_title”，通常是指切换模块的标题样式名；“toggle_title--special”，通常指一个有别于其它切换模块标题的、具有独立样式的标题样式名。
3、CSS文件的引入：
统一在html文件中的head标签内使用link 标签引入，如：<link href="../css/bootstrap.min.css" rel="stylesheet">。
为方便代码的维护、扩展、调式，避免写行内样式（div style=”font-size:14px; width:300px;”）,应采用‘div class=”list_1”’等方式引用。
4、CSS文件存放目录结构配置：
统一将样式文件放在CSS根目录下（图1所示）。
如样式文件过多，可根据项目模块划分，在根目录下建模块文件夹，将该模块样式文件对应放入（图2所示）。
图例：
CSS文件夹CSS文件夹
reset.css reset.css
common.css common.css
base.css base.css
userCenter
base.css
popup.css
图1：所有CSS文件统一在根目下图2：建了模块文件夹
三、JS文件命名及编写规范
1、命名规则
采用小写英文字母命名，后缀.js。
如： common.js，如编写插件，则以“plugin_”开头，以具体功能名称结尾，如：plugin_ dialog.js。
编写规范：每个功能函数及需要作标注的地方插入注释。
注意语法规范，以分号结尾。
为提高性能及用户体验，JS文件及代码应放在html文件的最底部（除了一些特定的JS文件，在页面刷新时必须先加载的，需要放在head中之外。
如移动端适配的“flexible.js”）。
2、JS文件的引入：
(1)在html文件中以“script”标签引入，如：<script
src="../js/jquery.min.js"></script>；
(2)在html文件底部内嵌JS代码，如：
<script>
//日期控件
$('#start1').click(function(){
WdatePicker({
maxDate:'#F{$dp.$D(\'end1\',{d:-1});}',
readOnly:true
});
});
$('#end1').click(function(){
WdatePicker({
minDate:'#F{$dp.$D(\'start1\',{d:1});}',
readOnly:true
});
});
</script>
3、JS文件存放目录结构配置：
统一将脚本文件放在JS根目录下。
如文件过多，可根据项目模块划分，在根目录下建模块文件夹，将该模块JS文件对应放入。
插件单独建文件夹“plugins”，所有JS插件都放在其内。
文件存放结构布局参考上文中的“CSS文件存放目录结构配置”。
注：如果使用的JS插件含有独立的图片及样式文件，需将整个插件所有文件均放入JS/plugins 文件夹内，不要分离该插件的资源文件。
四、图片命名
1、命名规则
采用小写英文字母 || 数字 || _ 的组合，其中不得包含汉字 || 空格 || 特殊字符；尽量用易懂的词汇, 便于团队其他成员理解; 另, 命名分头尾两部分, 用下划线隔开, 比如ad_left01.gif || btn_submit.gif;
2、背景图片（采用CSS background-position定位的图片）命名：
(1)sprite拼图命名规则：
图标：icon_sprite，如有多张，可以 icon后面跟数字，如：icon01_sprite；
组件：组件名称_sprite，如：nav_sprite、foot_sprite、header_sprite、form_sprite；
页面内容中用到的背景图片：cont_sprite，如有多张，可以在cont后面跟数字，如：cont01_sprite；
(2)单张图片命名规则：
采用小写英文字母和数字相接合，如：notfand.png、phone.jpg、 cont01.png、cont02.png……
3、前景图片（采用标签元素 img src引入的图片）命名：
命名规则：采用小写英文字母和数字相接合（可按区域块），如：list01.jpg、img01.jpg、pic01.png……
注意：页面中如果图片元素是作为动态数据来展示的，采用前景图片引入法，即<img src=”***.jpg”>。
这些图片仅对前端编写html文件提供效果展示。
除此之外的图片应使用背景图片定位方式导入，比如小图标等等。