HTML+CSS编写规范
HTML/CSS代码开发规范文档
HTML/CSS 代码开发规范文档
第 1页
HTML/CSS 代码开发规范文档
目录
1、前言...............................................................................................................................................3 2、HTML 编码规范............................................................................................. 3
2-1HTML 标记的关闭规范
HTML 文 档 的 正 文 都 应 在 <body></body> 标 记 中 间 , 而 <body> 标 记 则 应 包 含 在 <html> 和 </html>标记之间。如: <html > <body>正文</body> </html> 不同类的标记不能交叉编码: eg: <p><font>内容</p></font> 正确编码应为:<p><font>内容</font></p> 开始和关闭标记放在一行的标记有:
2-1HTML 标记的关闭规范.......................................................................................................3 2-2HTML 文件头基本标记.......................................................................................................3 2-2HTML 正文代码标记元素...................................................................................................4 2-3HTML 标记的缩进规范.......................................................................................................5 3、HTML 文件引入 CSS 样式代码和 Javascript 代码规范...........................................................5 3-1 引入 css 样式代码规范....................................................................................................... 5 3-2 引入 Javascript 代码规范.................................................................................................... 6 4、HTML 注释标签<!--和-->.......................................................................................................... 7 5、CSS 编码规范.............................................................................................................................. 7 5-1 CSS 编码要求...................................................................................................................... 7 5-2 CSS 样式表规范.................................................................................................................. 7 5-3 CSS 命名规范...................................................................................................................... 8 5-4 样式文件命名...................................................................................................................... 9 5-5 样式文件布局.................................................................................................................... 10 6、CSS 常规书写规范及方法........................................................................................................ 10 6-1 文件调用方法:................................................................................................................... 10 6-2 CSS 结构化书写................................................................................................................ 10
HTML中css代码规范问题汇集
HTML中css代码规范问题汇集很多人刚开始接触的时候都会遇到很多困难,其中规范的书写格式也较为明显;今天为大家带来一些CSS代码规范的知识。
1.良好的命名规范ID和class的命名尽可能短,并符合语义。
多个单词的拼接用'-' 符号链接,尽量使用小写字母。
2.代码缩写CSS代码缩写可以提高你写代码的速度,精简你的代码量。
li{ font-family:Arial, Helvetica, sans-serif;font-size: 1.2em;line-height: 1.4em;padding-top:5px;padding-bottom:10px;padding-left:5px;}可以缩写成li{font: 1.2em/1.4em Arial, Helvetica, sans-serif;padding:5px 0 10px 5px;}3.使用Reset但并非全局Reset全局Reset不仅仅因为它是缓慢和低效率的方法,而且还会导致一些不必要的元素也重置了外边距和内边距。
*{ margin:0; padding:0; }4.利用CSS继承如果页面中父元素的多个子元素使用相同的样式,那最好把他们相同的样式定义在其父元素上,让它们继承这些CSS样式。
这样你可以很好的维护你的代码,并且还可以减少代码量。
那么本来这样的代码:#container li{ font-family:Georgia, serif; }#container p{ font-family:Georgia, serif; }#container h1{font-family:Georgia, serif; }就可以简写成:#container{ font-family:Georgia, serif; }5.使用多重选择器你可以合并多个CSS选择器为一个,如果他们有共同的样式的话。
这样做不但代码简洁且可为你节省时间和空间。
阿里前端开发规范
阿里前端开发规范阿里前端开发规范包括代码、命名、HTML、CSS、JavaScript、图片方面的规范。
1. 代码规范:- 使用四个空格缩进,不使用制表符。
- 代码行长度不超过80个字符。
- 使用驼峰命名法,变量和函数名用小写开头,构造函数用大写开头。
- 使用严格相等运算符(===和!==)替代宽松相等运算符(==和!=)。
- 在条件表达式中,使用括号来提高可读性。
- 避免在循环中使用等号赋值(例如,for (var i = 0; i < array.length; i++))。
- 避免使用eval()函数。
2. 命名规范:- 文件名应该全部小写,可以包含破折号(-)或下划线(_)。
- 文件夹名应该全部小写,可以包含破折号(-)或下划线(_)。
- CSS文件名应该以.css结尾。
- JavaScript文件名应该以.js结尾。
3. HTML规范:- 使用两个空格缩进,不使用制表符。
- 使用双引号而不是单引号作为属性值的引号。
- 在自定义属性中使用小写字母和破折号(-)。
- 为所有非自闭合标签使用闭合标签。
- 避免在HTML标签中使用行内样式。
4. CSS规范:- 使用两个空格缩进,不使用制表符。
- 使用小写字母和破折号(-)作为选择器和属性名的命名方式。
- 为每个选择器之间使用空行分隔。
- 使用简写属性来减少代码量。
- 使用预处理器(如Less或Sass)来编写CSS。
5. JavaScript规范:- 使用两个空格缩进,不使用制表符。
- 使用分号作为语句的结束符号。
- 避免使用全局变量。
- 避免使用with语句。
- 使用模块化的开发方式,避免全局作用域污染。
6. 图片规范:- 使用有意义的命名来描述图片内容。
- 使用适当的格式和压缩技术来减小图片文件大小。
- 将页面上的图片引用写成相对路径。
以上是阿里前端开发规范的一些主要内容。
在实际开发中,遵循这些规范可以提高代码的可读性和可维护性,使团队成员之间更容易协同工作。
学习HTML和CSS的基本知识和语法规则
学习HTML和CSS的基本知识和语法规则第一章:HTML基本知识和语法规则1.1 HTML的定义和作用HTML是一种用于创建结构化文档的标记语言,用于描述网页的结构和内容。
它通过标签来对文本、图像、链接等进行分类和定义,使网页的结构清晰可读。
1.2 HTML文档的结构一个HTML文档通常由DOCTYPE声明、html标签、head标签和body标签组成。
其中,DOCTYPE声明用于告诉浏览器使用哪个版本的HTML解析文档,html标签定义了整个文档的根元素,head标签包含了关于文档的元信息,而body标签则包含了网页的实际内容。
1.3 HTML元素和标签HTML中的元素由一个起始标签和一个结束标签包围,起始标签和结束标签之间是元素的内容。
例如,<p>这是一个段落。
</p>中的<p>标签用于定义一个段落,而</p>标签用于结束该段落。
1.4 HTML属性HTML元素可以具有属性,属性为元素提供了额外的信息。
属性通常包含了名称和值,中间以等号连接。
例如,<imgsrc="image.jpg" alt="Image">中的src和alt就是img元素的属性,分别指定了图片的路径和替代文本。
第二章:CSS基本知识和语法规则2.1 CSS的定义和作用CSS(层叠样式表)是一种用于定义HTML文档中元素的样式的标记语言。
它通过选择器和声明来选择特定的HTML元素,并为其指定样式。
CSS的作用是提供了更好的可读性和可维护性,使得网页设计更加灵活和丰富。
2.2 CSS的引入方式在HTML文档中使用CSS有三种方式:内联样式、内部样式表和外部样式表。
内联样式通过在HTML元素的style属性中直接指定样式来引入,内部样式表则通过在HTML的head标签内使用<style>标签定义样式,外部样式表则是将CSS代码存放在独立的.css文件中,然后在HTML中使用<link>标签引入。
HTML,CSS编码规范
HTML、CSS编码规范1.基本原则* 遵循内容(HTML)、显示(CSS)、行为(JavaScript)分离的代码组织模式* 代码格式化,保持干净整洁2.HTML部分2.1.添加必须的utf-8的字符集,并且使用HTML5的简洁方式:<meta charset="utf-8" />2.2.遵循xhtml 1.0规则:1)所有标签必须小写2)标签属性必须使用成对引号(单引号或双引号)3)标签属性必须有值:<select><option selected="selected"></option></select><input type="checkbox" checked="checked" />4)特殊符号必须转义(&、<、>、©、»…)2.3.标签属性命名规范id:_连接符命名法“hello_world”class: -连接符命名法“hello-world”name:骆驼式命名法“helloWorld”1)表单元素的id必须加以下前缀label:lbltext:txtpassword:txttextarea:txtfile:txtradio:radcheckbox:chksubmit:btnreset:btnbutton:btnhidden:hid2)应使用统一的结构布局的元素id命名3)name命名一般用于表单元素,根据当前元素id属性值命名,去掉id属性值的前缀和所有连接符,使用骆骆式命名法命名,例如id=”txt_id_card”,那么name=”idCard”。
2.4.要合理使用标签,语义化结构1)标签合理嵌套a、span、strong、em、p、h1~h6等元素不能包含:div、ul、ol、dl、p2)避免多余的div、span、table标签,正确使用标签表现DOM结构,在文档去除css的情况下,仍然具有结构和可读性,以下是html标记的使用规范:p:文本段落;dl:定义列表,可包括标题和内容简介的列表;ul:无序列表;ol:有序列表;h1~h6:文章标题、内容区块标题,根据重要性由大到小区分,h1一个页面只出现一次;strong/em:强调文本;img:图像,必须加上alt属性,当图像无法显示时,可表示图像信息,背景和按钮使用css 处理,不使用img元素;3)合理化表单结构a)使用fieldset元素包裹相同类别的字段;b)使用legend元素表示字段类别名称;c)使用label表示字段文本,添加必要的for属性,以在点击字段文本时,文本框能获得焦点;d)文本框不使用size属性定义宽度,而使用css的width属性;e)要添加maxlength属性限制输入字符的长度。
html-css规范
目录1. 概述 (3)2. 规范化 (3)2.1规范化简述……………………………………………………………………. 错误!未定义书签。
2.2规范化的面向对象 (3)3. html代码规范 (3)3.1htm通用模板 (3)3.2met标签说明 (5)3.3页面内嵌式样式表和内嵌式javascript说明 (6)3.4xhtml代码规范 (7)4. css代码规范 (8)4.1 共享css模板 (8)4.2 css代码书写规范 (11)5. 网站文件规范 (14)5.1html文件规范 (14)5.2 css文件规范 (18)5.3 html文件命名规范 (20)5.4css文件命名规范 (21)5.5 图片及动画命名规范 (21)1. 概述本规范是一个开发规范,本规范并不是一个一成不变的必须严格遵守的条文,特殊情况下要灵活运用,做一定的变通。
但是,请大家千万不要随意更改规范。
2.规范化2.1 规范化简述强调制作的规范是必要的,因为大型网站项目需要多人的配合协同工作,个性化的东西无法产生良好的聚合效果。
规范化不是特殊的个人风格,它可以提高编码工作效率,使代码保持统一的风格,以便于后期的维护。
2.2规范化的面向对象网页制作人员及编辑人员、技术开发人员。
3. html代码规范3.1html通用模板“/TR/xhtml1/DTD/xhtml1-transitional.dtd”><html xmlns=”/1999/xhtml”><head><title>Portal</title><meta http-equiv=”Content-Type”content=”text/html; charset=utf-8″/><link type=”text/css”rel=”stylesheet”href=”css/common.css”media=”all”/> <link type=”text/css”rel=”stylesheet”href=”css/landing.css”media=”all”/> <script type=”text/javascript”src=”js/prototype.js”></script></head><body>……</body></html>说明:“/TR/xhtml1/DTD/xhtml1-transitional.dtd”>为DOCTYPE声明,DOCTYPE是document type(文档类型)的简写,用来说明你用的XHTML 或者HTML是什么版本。
HTML和CSS编码规范内容
HTML和CSS编码规范内容一、HTML规范二、CSS规范三、注意事项:四、常用的命名规则五、CSS样式表文件命名六、文件命名规则一、HTML规范:1.代码规范•页面的第一行添加标准模式声明<!DOCTYPE html>•代码缩进:tab键设置四个空格(通常在软件右下角设置相应空格大小)•html中除了开头的DOC和'UTF-8'或者head里特殊情况可以大写外,其他都为小写,css类都为小写•建议为html 根元素指定lang 属性,从而为文档设置正确的语言lang="zh-CN"•不同doctype在不同浏览器下会触发不同的渲染模式<meta http-equiv="X-UA-Compatible" content="IE=Edge"><!DOCTYPE html><html lang="zh-CN"><head><meta charset="UTF-8"><meta http-equiv="X-UA-Compatible" content="IE=Edge"></head>....</html>•不要使用@import•与<link> 标签相比,@import 指令要慢很多,不光增加了额外的请求次数,还会导致不可预料的问题。
替代办法有以下几种:•使用多个<link> 元素•通过Sass 或Less 类似的CSS 预处理器将多个CSS 文件编译为一个文件•通过Rails、Jekyll 或其他系统中提供过CSS 文件合并功能<!-- Use link elements --><link rel="stylesheet" href="core.css"><!-- Avoid @imports --><style>@import url("more.css");</style>________________________________________引入CSS 和JavaScript 文件•根据HTML5规范, 通常在引入CSS和JS时不需要指明type,因为text/css 和text/javascript 分别是他们的默认值<!-- External CSS --><link rel="stylesheet" href="code-guide.css"><!-- In-document CSS --><style>/* ... */</style><!-- JavaScript --><script src="code-guide.js"></script>________________________________________2.注释•<!--注释内容--!>注意:--后不要留空格,若留空格,其他注释全加空格(方便后续程序开发)换句话说,注释要全局统一eg:<!-- Better --!><!--S 注释内容--!>为书写规范,最好每一个需要注释都需要开头和结尾,减少后续麻烦和错误。
html-css代码规范
Google HTML/CSS代码风格指南修正版本 2.1背景本文档定义了HTML/CSS的编写格式和风格规则。
它旨在提高合作和代码质量,并使其支持基础架构。
适用于HTML/CSS文件。
样式规则目录文件命名名称全部用小写英文字母、数字、下划线的组合,其中不得包含汉字、空格和特殊字符。
目录名称应使用意义完整的英文描述或中文描述的首字母HTML文件名称应使用以下划线分隔的多英文单词或中文描述首字母的形式命名,要求能说明显示内容的信息,命名格式:模块名称_展示方式CSS文件名称应以所描述模块的英文名称或中文缩写的小写字母命名。
协议嵌入式资源书写省略协议头省略图像、媒体文件、样式表和脚本等URL协议头部声明( http: , https: )。
如果不是这两个声明的URL则不省略。
省略协议声明,使URL成相对地址,防止内容混淆问题和导致小文件重复下载。
排版规则缩进每次缩进一个个TAB键。
不要用多个空格来进行缩进或无缩进。
大小写只用小写字母。
所有的代码都用小写字母:适用于元素名,属性,属性值(除了文本和CDATA ),选择器,特性,特性值(除了字符串)。
行尾空格删除行尾白空格。
行尾空格没必要存在。
元数据规则编码用不带BOM头的UTF-8编码。
让你的编辑器用没有字节顺序标记的UTF-8编码格式进行编写。
在HTML模板和文件中指定编码<meta charset="utf-8"> . 不需要制定样式表的编码,它默认为UTF-8.(更多有关于编码的信息和怎样指定它,请查看Character Sets & Encodings in XHTML, HTML and CSS。
)注释尽可能的去解释你写的代码。
用注释来解释代码:它包括什么,它的目的是什么,它能做什么,为什么使用这个解决方案,还是说只是因为偏爱如此呢?css文件顶部多行注释。
/**@description:中文说明*@author:作者*@update:更新时间*/css文件内部单行注释。
前端技术的标准与规范
前端技术的标准与规范随着Web技术的发展,前端技术已逐渐成为开发领域的重要一环,前端的工具和技术也越来越多。
然而,单靠广泛的技术和工具是远远不够的,一个好的团队和项目都应该有一套完整且严格的标准和规范,来确保开发质量和交付时间。
本文将探讨一些前端技术的标准和规范,以帮助开发人员更好地组织、管理和交付前端项目。
1. HTML规范HTML是网页的基础,也是前端开发的核心语言,因此HTML规范的制定和遵循对于开发者来说至关重要。
以下是一些HTML常规规范:(1)避免使用具有函数功能的HTML标签,如`<font>`、`<center>`等。
(2)标签必须按嵌套层次正确书写。
(3)所有标签必须正确闭合。
(4)代码必须使用小写字母。
(5)class和id命名必须见名知意,不要使用拼音或缩写。
(6)类名和ID名应该使用中横线、下划线或者CamelCase的方式书写,例如:`.main-container`、`#my-id`或者`myClassName`。
(7)尽量不要嵌套过多的元素,在不影响布局的情况下避免使用没必要的容器。
2. CSS规范CSS是CSS规范的核心语言,开发人员需要遵循以下的CSS规范。
(1)所有样式一律采用外部css文件,不要在HTML页面里直接写内联样式,方便维护,减少代码冗余。
(2)每个选择器规则之间应该留一个空格,增加代码可读性。
(3)永远不要使用`!important`,除非确实需要覆盖某些已有样式。
(4)样式命名遵循BEM(Block, Element, Modifier)规范,例如:`.card__header---large`,其中`card`是块,`header`是元素,`large`是修饰符。
(5)用统一的命名规则来统一功能单元、类名的命名,在现有的CSS框架或第三方库中选择一个标准来限制自己的命名,这样就可以为你的网站带来一定的规范性。
(6)当样式表庞大且复杂时,应该尽量对样式进行分类以及分组,方便管理。
手把手教你编写HTML和CSS
手把手教你编写HTML和CSSHTML(超文本标记语言)和CSS(层叠样式表)是前端开发中最为基础的两种编程语言。
HTML用于创建网页结构,而CSS则负责美化网页的样式。
掌握这两种语言将为你成为一名优秀的前端开发人员打下坚定的基础。
在本文中,我们将手把手教你如何编写HTML和CSS,为你的前端开发之路插上一双翅膀。
一. HTML基础知识HTML是一种用于创建网页的标记语言,它由一系列的标签组成。
每个HTML 标签都有特定的用途,比如创建标题、段落或者图片等等。
以下是HTML中最常用的一些标签及其用法:1. <html>:定义HTML文档的根元素。
2. <head>:定义HTML文档的头部,包含一些元数据,比如页面的标题等。
3. <title>:定义网页的标题,将显示在浏览器的标题栏中。
4. <body>:定义HTML文档的主体部分,包含网页的内容。
5. <h1>到<h6>:定义标题,从<h1>到<h6>分别表示不同级别的标题。
6. <p>:定义段落,用于展示一段文字内容。
7. <img>:插入图片,需要指定图片的文件路径和一些其他属性。
以上只是HTML标签的冰山一角,当然还有许多其他标签和属性。
掌握HTML标签的使用方法是编写网页的基础。
二. CSS样式美化CSS是一种用于控制网页样式的语言,它可以改变HTML元素的外观和布局。
通过CSS,我们可以改变网页的字体、颜色、大小、边框和背景等属性。
下面是一些常用的CSS属性:1. color:设定元素的字体颜色。
2. font-size:设定元素的字体大小。
3. font-family:设定元素的字体样式。
4. background-color:设定元素的背景颜色。
5. border:设定元素的边框样式。
通过将CSS样式与HTML标签结合使用,我们可以给网页添加美观的外观。
前端代码规范(HTM、CSS、JS)
前端代码规范(HTM、CSS、JS)程序员写好看的代码,不亚于写一行好看的字好看的代码总是让人心旷神怡,不好,不规范的代码,让人看了想说mmp,那我们就来学习一下规范的代码怎么写的吧以下来自B站的学习视频:前端必备-阿里大厂前端开发规范!1、命名规范1.1 项目命名·全部采用小写的方式·以下划线分割正确命名:sdgk_app 或 gkux_yxtool_app错误命名:mall-management-system或mallManagementSystem1.2 目录命名·全部采用小写的方式·以中划线命名·复数时,要采用复数结构正确命名:sctipts / styles / utils / demo-scripts1.3 JS、CSS、SCSS、HTML、PNG等文件命名·全部采用小写的方式·以中划线命名正确命名:render-dom.js / signup.css / index.html / company-logo1.4 命名严谨性·严禁使用拼音和中文混合的方式·严禁使用中文、中文拼音·正确使用英文拼写和语法·一些特殊的词语可以采用国际通用的名称如:河南=henan / 人民币=rmb正确命名:movie(电影) / employee(员工)错误命名:dianyin(电影)condition --> condi (×)2、HTML规范(Vue Template通用)2.1 HTML类型·推荐使用 HTML5 的文档类型申明<!DOCTYPE html>·规定的字符编码<meta charset="UTF-8">· IE兼容模式<meta http-equiv="X-UA-Compatible"content="IE-Edge">· doctype 大写2.2 缩进·一个tab 使用四个空格·嵌套的节点应该缩进2.3 分块注释在每一个块级元素,列表元素和表格元素中,加上一对HTML注释,注释格式<!-- 英文中文 start --><!-- 英文中文 end -->例如:<!-- header 头部 start --><header><div><a href=""></a></div></header><!-- header 头部 end -->2.4 语义化标签HTML5 有很多语义化标签,优先使用这些语义化标签,避免每一个页面都是div或者phtml标签中使用双引号" ",而不是单引号''3、CSS 规范3.1 命名·类名使用小写字母,以中划线分割.swiper-image{ ... }· id 使用驼峰式命名#header{ ... }· scss中的变量、函数、混合、placeholder采用驼峰命名·ID和class 的名称总是使用可以反应元素目的和用途的名称,或其他通用名称,代替表象和晦涩难懂的名称不推荐:.fw-800{font-weight: 800;}.red{color :red;}推荐:.heavy{font-weight : 800;}.important{color :red;}3.2 选择器1)css选择器中避免使用标签名从结构、表现、行为分离的原则来看,应该尽量避免css中出现HTML标签,并且在css选择器中出现标签名会存在潜在的问题。
HTML/CSS代码开发规范文档
HTML/CSS代码开发规范文档一、引言为保证团队内部的代码质量和项目的可维护性,制定本规范文档,以规范HTML/CSS代码的书写和组织结构。
二、命名规范1.使用有意义的命名:变量、类名、ID等命名应具有描述性,能够清晰表达其用途或含义。
2.使用小写字母:统一使用小写字母命名。
3.使用连字符或下划线:命名时使用连字符(-)或下划线(_)作为单词之间的分隔符。
4.避免名称冲突:确保命名的唯一性,避免重复使用相同的名称。
三、HTML规范2.缩进与格式化:使用2个空格缩进,并保持代码整洁格式化,方便阅读和维护。
5.注释:在代码中添加注释,清晰描述代码的作用和用途。
8.避免使用行内样式:尽量避免使用行内样式,将样式集中在外部样式表中。
四、CSS规范1. 样式文件命名:样式文件统一使用小写字母,并以"-"分隔单词,如"style.css"。
2.缩进与格式化:样式文件使用2个空格缩进,并保持代码整洁格式化。
3. 使用简写属性:尽量使用简写属性来减少代码量,例如:margin、padding、font等。
4. 属性书写顺序:按照以下顺序书写CSS属性:定位(position)、盒模型(margin、padding、border)、文本(font、text)、背景(background)、浮动(float)、尺寸(width、height)等。
5.分号与括号:每个属性声明末尾都加上分号,并使用大括号包裹属性块。
6. 前缀属性:为增加浏览器兼容性,使用浏览器前缀属性,例如:-webkit、-moz、-o、-ms等。
7. class和ID选择器:尽量使用class选择器,避免使用ID选择器,以提高样式的通用性和复用性。
8.媒体查询:根据页面布局和各个设备的分辨率,使用媒体查询来优化页面的响应式效果。
五、版本控制与文档维护1. 版本控制:使用Git等版本控制工具来管理代码,并在每次修改后提交到版本库。
HTML-CSS开发规范
研发部HTML/CSS开发规范目录文件命名 (3)HTML规范 (3)文件定义 (3)HEAD规范 (3)HTML规范 (3)HTML书写建议 (4)CSS开发规范 (4)命名规范 (4)兼容性 (5)CSS规范 (5)CSS书写建议 (6)文件命名命名指导思想是能够方便的理解每一个文件的意义,当按名称排列时,同一种类的文件能够排列在一起,方便查找、修改等操作。
1.文件统一使用UTF-8编码保存。
2.文件与目录命名采用英文,长度一般不超过30个字符,名称统一用小写的英文字母、数字和下划线的组合。
3.每一个目录中包含一个缺省的html文件,文件名统一用index.htm。
4.样式表文件第一行声明如:@charset"utf-8"。
5.样式表文件可以用一个公用样式表,除了公用样式表外,以模块建立单独的CSS。
6.如果需要换肤,则命名按色彩来命,比如:red.css/blue.css/green.css。
HTML规范为改善可读性,规范使用XHTML标准(除DOCTYPE引用外)。
文件定义<!DOCTYPEhtmlPUBLIC"-//W3C//DTDXHTML1.0Strict//EN"http:///TR/xhtml1/DTD/xhtml1-strict.dtd/>HTML5定义<!DOCTYPEhtml/>HEAD规范至少包括以下内容:<metahttp-equiv="Content-Type"content="text/html;charset=gb2312"><metaname="author"content=""><metaname="copyright"content=",版权所有"/><title></title>:使用-或空格作为title的分隔符。
前端开发规范文档
前端开发规范文档引言本文档旨在定义一套前端开发规范,规范涵盖了HTML、CSS和JavaScript的编码规范、文件组织规范以及注释规范等内容。
在项目中,所有前端开发人员必须遵守本文档中的规范,并且在开发过程中互相审查和纠正代码中的违规行为,确保项目的代码质量和可维护性。
一、HTML规范2.使用4个空格作为缩进,而不是制表符或者2个空格。
5.遵循嵌套顺序:结构、表现、行为。
二、CSS规范1.使用4个空格作为缩进,而不是制表符或者2个空格。
2.使用有意义的类名和ID,避免使用无意义的名称。
3.使用层级结构书写选择器,不要过分依赖后代选择器。
4. 使用-来连接多个单词的类名,例如.nav-bar。
5.避免嵌套选择器的层级过多,不超过3层。
6.选择器和属性之间使用空格隔开。
7.属性值为0时不需要单位。
8. 使用!important应该极少使用,并在必要的情况下给出充分的解释。
三、JavaScript规范1.使用4个空格作为缩进,而不是制表符或者2个空格。
2.使用驼峰命名法命名变量、函数和对象。
3. 使用let或const来声明变量,避免使用var。
4.在比较操作符中使用严格相等===和!==。
5.使用模板字符串来拼接字符串。
6.缩写应该避免,命名要具有描述性。
7.避免使用全局变量,尽量将变量的作用域限制在需要的范围内。
四、文件组织规范1. 将不同的文件放在不同的目录下,例如:css/、js/、img/。
2.使用有意义的文件名,避免使用无意义的名称。
3.遵循模块化的原则,将功能相关的代码组织到一个模块中。
4.使用版本控制系统来管理代码的版本和变更。
五、注释规范1.在代码的重要部分和复杂部分添加注释,解释代码的用途和实现方式。
2.使用单行注释//来注释一行代码,使用多行注释/**/来注释多行代码。
3.注释应该与代码对齐,并且清晰明了。
4.注释的语言要简洁明了,不要废话。
结语本文档规范了前端开发的一系列规则和标准,旨在提高团队的协作效率和项目的代码质量。
CSS模块化、HTML、CSS、jS书写规范
CSS模块化、HTML、CSS、jS书写规范>CSS模块化百度百科模块化:在系统的结构中,模块是可组合、分解和更换的单元。
模块化是⼀种处理复杂系统分解成为更好的可管理模块的⽅式。
它可以通过在不同组件设定不同的功能,把⼀个问题分解成多个⼩的独⽴、互相作⽤的组件,来处理复杂、⼤型的软件。
类似于拼图。
当做⼀个⼤项⽬,⼏个⼈团队合作开发,结果看不懂彼此的代码,怎么办,当⾯对前⼈已经写好代码,需要修改,可是⽆处下⼿,怎么办.当代码耦合,修改费时费⼒,怎么办,当需要迭代,⾯对庞⼤的代码,牵⼀发动全⾝的悲催时刻,怎么办,这个时候,模块化思想就是救星了。
css写法特别的灵活,也因为灵活,所以容易耦合在⼀起,这时候就需要进⾏模块化的分离。
好处:●提⾼开发效率、减少沟通成本●提⾼页⾯容错●降低耦合●降低发布风险●减少Bug定位时间和Fix成本●更好的实现快速迭代●便于代码维护...>>命名实现CSS模块化需要很多步,今天先说命名。
css命名上的优化:css⽂件名的命名、css选择器的命名。
1、CSS样式⽂件命名:1、主要的 master.css布局,版⾯ layout.css专栏 columns.css⽂字 font.css打印样式 print.css主题 themes.css2、对浏览器的默认样式进⾏重设 reset.css管理页⾯的布局 layout.css图⽂的编排 typeset.css统⼀管理颜⾊的搭配 color.css打印效果样式 print.css把对ie的hack单独分开 ie.css3、对浏览器的默认样式进⾏重设 reset.css头部的所有样式 header.css除头部/底部外的中间区域样式 container.css底部样式 footer.css打印效果样式 print.css把对ie的hack单独分开 ie.css4、页⾯样式重置 reset.css全站头部样式 header.css全站尾部样式 footer.css全站公共模块样式 public(base/common).css⾸页特有样式 index.css⼆级及以下主体样式 container.css打印样式 print.cssIE hack ie.css /有最好的命名⽅式,只有最合适的命名⽅式。
HTML+CSS的书写格式
HTML+CSS的书写格式扯淡中的扯淡首先现在好多都叫div+css也有叫html+css,我个人也喜欢称它为html+css。
这个会从一个更高的层面上来看前端的标签,div只是html标签中的一个布局标签,它还有很多的标签,如果用div+css来起名,会让人感觉到页头同排版只有用div+css 也是标准化的页页(哈哈,本人刚起入这一行时常听到的是div+css,当时认为写成div 的代码加上css样式就是符合w3c标准了,这样有会一个狭隘的想法,会有一个误区是页面用了大量的div,这样的页面及没有符合语义又没有符合SEO优化。
随着对前端的理解慢慢改正过来了)。
W3C标准W3C标准是一系列的标准,包含:结构层(HTML标准)、表现层(CSS标准)、行为层(DOM标准)等标准;HTML+css要点:个人要书写前端(HTML+css)代码时总结几条适合自己的格式:HTML:1.div尽量用页面布局,而不要用于内容的布局;2.页面中对于有编号排列的集合用ol,因为它是有序的标签3.对于有标签有描述的片段(只的是小的模块)用dl它有一个dt 标题和dd对标题的一个描述;4.在使用H1--h6时,对于重要的内容用h1-h3,对于侧栏的页面用h4-h5可以满足需求,同时个人建议H标签用于栏目标题上,内容标题和标题的部分内容一起显示这时用DL的DT和DD一起使用,否则就使用H标签,在这里对于它们的使用顺序也要考虑一下;5.对于SEO优化的标签有二个比较重要的Strong和Em的。
它们的权重是很高的,Strong有重点,突出之意,em有强调提醒之意;6.Span标签在页面中的语义非常小,可以接合p em strong等这些标签配合使用,为了解决这个CSS定义时Class属性名的定义;7.对于有一个标题一个集合列表这样的模块,可以用H标签和UL标签使用。
这样的意义是标题下面紧跟一个集合,是对标题的一个集合列表;8.面向对象开发:首先分析设计原图(模块、CSS背景图片合并等),把每个模块看成一个对象来开发,然后抽象出父模块的HTML 和CSS进行封装。
简明 HTML CSS 开发规范标准
简明 HTML CSS 开发规出处:蓝色理想责任编辑:hsx//总论本规既是一个开发规,也是一个脚本语言参考,本规并不是一个一成不变的必须严格遵守的条文,特殊情况下要灵活运用,做一定的变通。
但是,请大家千万不要随意更改规。
如果有任何问题,请及时与我联系,我会及时更改本规的相关代码样例和文档。
/基本要求1. 在根目录中开设images common temp 三个子目录,根据需要再开设media 子目录,images目录中放不同栏目的页面都要用到的公共图片,例如公司的标志、banner 条、菜单、按钮等等;common 子目录中放css、js,、php、include 等公共文件;temp 子目录放客户提供的各种文字图片等等原始资料;media 子目录中放flash, avi, quick time 等多媒体文件。
2. 在根目录中原则上应该按照首页的栏目结构,给每一个栏目开设一个目录,根据需要在每一个栏目的目录中开设一个images 和media 的子目录用以放置此栏目专有的图片和多媒体文件,如果这个栏目的容特别多,又分出很多下级栏目,可以相应的再开设其他目录。
3. temp 目录中的文件往往会比较多,建议以时间为名称开设目录,将客户陆续提供的资料归类整理。
4. 除非有特殊情况,目录、文件的名称全部用小写英文字母、数字、下划线的组合,其中不得包含汉字、空格和特殊字符;目录的命名请尽量以英文为指导,不到万不得已不要以拼音作为目录名称,经验证明,用拼音命名的目录往往连一个月后的自己都看不懂,/脚本编写我们应该有一个脚本整体风格一致的概念,意思是一个月后和一个月前的你写的脚本风格保持一致,以及同一个工作组中不同的开发人员编写的脚本风格保持一致,因为我们不可能永远孤立的开发,你随时都有可能和三个月前的自己合作(你的客户要求改版),也经常要和工作室中不同的同事共同开发一个项目,还有可能被要求修改已经离职人员开发的脚本,当然你自己也有可能会扔下一个项目给后来的同事。
HTML+CSS编写规范
HTML代码编写规范一、说明在任何一个项目或者系统开发之前都需要定制一个开发约定和规则,这样有利于项目的整体风格统一、代码维护和扩展。
由于Web项目开发的分散性、独立性、整合的交互性等,所以定制一套完整的约定和规则显得尤为重要。
适用:本规范应用于html,div,css,xml等文件本文件二、命名规则命名是代码规划的核心,好的命名才能体现出代码的质量,使代码更加易懂和规范。
就一般约定命名应以能够描述让代码阅读者能够容易的知道这些代码的作用。
形式越简单、越有规则,就越容易让人感知和理解。
应该避免使用模棱两可,杂乱无章的命名。
命名一律为小写格式,以标准计算机英文为蓝本,杜绝一切拼音、或拼音英文混杂的命名方式;不可使用t1、t2这样容易产生混淆的形式,应当使用header、tophead这样一目了然容易理解的形式;可以合理的对过长的命名进行缩写,例如bio(biography),tpp(threadsPerPage),前提是英文中有这样既有的缩写形式,或字母符合英文缩写规范(附件为英文缩写规则);三、书写规范良好的代码格式使得代码显示更加规范易懂且结构清晰。
为此我们制定了以下标准化书写规则:3.1 缩进每个缩进的单位约定是一个TAB(8个空白字符宽度),需每个参与项目的前端人员在编辑器(Dreamweaver、EditPlus、Expression Web等)中进行强制设定,以防在书写代码时遗忘而造成格式上的不规范。
本缩进规范适用于Html,Css、JavaScript等。
3.2 排版在书写代码时同级标签要整齐横向或竖向排列,不同层级的标记必须进行缩进.简化布局层次,避免多余的层次嵌套而造成的代码冗余。
3.3 CSS中Class与ID一个Class是用来根据用户定义的标准对一个或多个元素进行定义的。
你可以在一个文档中使用任意次数的Class。
至于ID,通常用于定义页面上一个仅出现一次的标记。
在对页面排版进行结构化布局时(比如说通常一个页面都是由一个页眉,一个报头,一个内容区域和一个页脚等组成),一般使用ID比较理想,因为一个ID在一个文档中只能被使用一次。
网站建设html+css代码编写时的注意事项
网站建设html+css代码编写时的注意事项
网站建设html+css代码编写时的注意事项:
1.浮动时记得清除浮动
在没有清楚浮动的情况下,会出现跑格。
页面会发生变形。
2.有效利用padding和border
边界重合时,使用padding和border可以避免,可以防止上下div的“塌陷”,合理的控制上下div的间距。
3.记住“TRBL”写法
border,margin与padding的简写语法有特定顺序,从上方开始顺时针方向转动:top,righ t,bottom,left. 所以margin:0 1px 3px 5px;的结果是上方无边界,右边1像素,以此类推。
4.不是零的值,都要指定单位
CSS需要对每个font,margin等各种值指定单位。
5.解决IE6的浮动元素的双倍边距问题
对一个div设置了float:left 和margin-left:100px 在IE6中,这个bug就会出现。
只需要多设置一个display就行了。
6.!important;
如果实在没有办法解决一些细节问题,可以用这个方法.火狐对于”!important”会自动优先解析,IE则会忽略。
- 1、下载文档前请自行甄别文档内容的完整性,平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益,请联系客服反馈,我们会尽快为您处理(人工客服工作时间:9:00-18:30)。
HTML+CSS编写规范
在任何一个项目或者系统开发之前都需要定制一个开发约定和规则,这样有利于项目的整体风格统一、代码维护和扩展。
由于Web项目开发的分散性、独立性、整合的交互性等,所以定制一套完整的约定和规则显得尤为重要。
1、CSS样式文件的命名
建立样式表文件时,分类编写样式到下列样式表文件中,并统一放在【CSS】文件夹里:
在项目初期,会把不同类别的样式放于不同的CSS文件,是为了CSS编写和调试的方便,在项目后期会为了网站性能上的考虑会整合不同的CSS文件到一个CSS文件,必要时可压缩。
2、CSS选择符的命名
所有选择符必须有小写英文字母或“_”下划线组成,样式名必须是表示该样式的大概含义(禁止出现如Div1、div2、Style1……),参考后面的“样式命名参考”。
对CSS选择器的使用只允许派生选择器、类选择器和属性选择器,以及它们的组合使用,严禁使用ID选择器(ID是用于JavaScript的编写)。
如:li spa n {…}td.fancy {…}input[type="text"]{…}
当定义的样式名比较复杂时用下划线把层次分开,比如:dcrm_logo{ …}
dcrm_logo_ico{…}
3、图片的命名与书写
图片的命名原则小写英文字母名称放在头尾两部分,用“_”下划线隔开,头部表示此图片的大类性质例如广告、标志、菜单、按钮等等;尾部表示图片的概念。
设计人员在PS中保存图片时,请使用“文件”à“存储为Web和设备所用的格式”。
4、CSS 注释书写规范
4.1 提示和标签信息注释
这是注释最常用的途径,可以为自己或其他开发人员留下提示信息可以避免后期引起的注意:注释内容和前面样式语句间有3个空格,后面1
个空格
4.2 修改样式注释(时间和相关人员)
4.3 文档结构
注意:相对独立的2段内容之间空1行。
5、 CSS布局编码标准和建议
5.1 建立样式表索引
样式表头部索引定义可以帮助你和其它人弄清楚该样式表文件的相关信息,它一般是一段格式化的CSS注释文本写在main.css中。
给出该CSS文件作者的相关信息;定义站点的布局,记录文件版本号(利于多作者协作及将来更新)。
5.2 命名锚点的使用
命名锚点是用来规划整个CSS文件结构的(就好像书签一样),从而使整个CSS文件获得良好的组织。
命名锚点一般也是书写在样式表头部的索引注释中。
CSS本身没有内部的锚点系统,所以我一般采用下面的小技巧来完成。
在头部索引拷贝你想找到的锚点,并在整个文档中查找,从而获取该CSS节。
5.3 建立良好的CSS编码顺序
最后定义的CSS 样式将会覆盖在其之前定义的所有已经存在、或与之冲突的样式,比如下面这个例子:
以上的段落最终将呈现绿色的字体,并带有黄色的背景,这是因为最后定义的color:green 将之前定义的red 覆盖掉了,至于黄色背景为何没有消失,那是因为第二个p 的定义中并没有与之冲突的定义,因此它还是有效的。
5.4 合适的缩写
在CSS中经常会利用缩写把多个相同类型的属性定义指定为一个。
CSS缩写会使CSS 文档更加干净、简洁;缩写语法参考相关章节。
5.5 CSS图像拼合(即CSS Sprites技术)
CSS Sprites技术:将用到的所有小图片(图标)合并为一张图片,使用css背景属性,来控制图片的显示位置和方式。
CSS Sprites技术的应用可以大大减少HTTP请求的次数,减轻服务器压力,同时缩短了悬停加载图片所需要的时间延迟,使效果更流畅,不会停顿。
5.6 CSS组合和嵌套
CSS组合
你不必重复有相同属性的多个选择符,你只要用英文逗号(,)隔开选择符就可以了。
CSS结构好的话,没有必要使用过多的类或者标识选择符。
这是因为你可以指定在选择符内的选择符。
六、常用CSS选择符命名参考
注意:命名方式使用“类别_功能”的方式(.bar_news{} .bar_product{})。
七、DIV+CSS页面的布局
Table布局由于代码冗余已经过时,所以HTML页面普遍采用代码简洁Div+CSS的布局,HTML页面大体可分为top、main和bottom,在main中又可以为left和right,这些CSS的名必须是有意义的名字。
如下面代码:
<body>
<div class="body">
<div class="top">
</div>
<div class="main">
<div class="left">
</div>
<div class="right">
</div>
</div>
<div class="bottom">
</div>
</div>
</body>
目前table主要是用来展现数据表,反正在布局中尽量少用table。
八、HTML代码书写规范
页面的HTML代码书写必须符合XHTML规范,XHTML 可以被所有的支持XML 的设备读取,同时在其余的浏览器升级至支持XML 之前,XHTML 使我们有能力编写出拥有良好结构的文档,这些文档可以很好地工作于所有的浏览器,并且可以向后兼容。
XHTML与HTML的不同:
1. XHTML 元素必须被正确地嵌套。
2. XHTML 元素必须被关闭。
3. 标签名必须用小写字母。
4. XHTML 文档必须拥有根元素。
对于第1点:最有可能发生错误是在与<table>标签的结合,<table>的直接子元素只能为:<thead>、<tbody>、<tfoot>和<tr>,而<thead>、<tbody>和<tfoot>的直接子元素只能为:<tr>,而<tr>的直接子元素只能为<td>和<th>,在<td>和<th>才可以放其它标签。
此外相类似的标签有:<dl>、<ul>、<ol>、<select>…。
某些标签不推荐使用,如:
<b><strong><i><em><strong><dfn><code><samp><kbd><var><cite>……,因为这些标签有些是可以用CSS去统一控制,还有一些是不常使用的;某些标签是有特殊意义的,如:<h1>…<h6>,这些标签是专门用于内容标题的,本人也希望只允许使用<h1>…<h6>来表示内容标题。
在编写HTML代码时请注意缩进,在VS中按Ctrl+E+D可格式化文本。
九、网站基础CSS的定义
网站CSS必须得有个统一的架构,复用CSS,尽量减少重复CSS的定义。
基础CSS 就是那些常用的CSS定义,如:
text-align: left;
}
.error
{
color: Red;
}
.succeed
{
color: Green;
}
.center
{
text-align: center; }
.fleft
{
float:left;
}
.fright
{
float:right;
}
.left15
{
margin-left: 15px; }
.radius
{
十、CSS调试心得
目前的浏览器基本上都有客户端调试工具,所以当对页面进行设计或调试时,请尽量使用此类工具,而不是改源文件,然后再刷新页面,使用客户端工具可及时增、删、改HTML 元素所对应的CSS,还可以得到HTML元素所在布局的具体数值,如:
在项目后期进行CSS调试时应,着重于页面展现给浏览器后形成的HTML+CSS代码,而不是关注于源文件,因为页面上很多元素是源文件里没有的,是动态生成的,对于那些动态生成的HTML元素,看看作用在它上面的CSS是哪些,再去修改其CSS或添加新的CSS。
对于CSS3,如果CSS3能达到更好的视觉效果,那就使用,不用去管那些不支持CSS3的浏览器,毕竟CSS3是一发展趋势,对于静态页面的设计人员也应该熟悉CSS3的那些效果(比如圆角、文字阴影……),来代替之前需要用图片来实现的效果。