当前位置:Gxlcms > html代码 > 编写灵活、稳定、高质量的HTML和css代码规范指南

编写灵活、稳定、高质量的HTML和css代码规范指南

时间:2021-07-01 10:21:17 帮助过:45人阅读

黄金定律
永远遵循同一套编码规范,不管有多少人共同参与同一项目,一定要确保每一行代码都像是同一个人编写的.

一、语法:
1.用两个空格来代替制表符(tab);
2.嵌套元素应当缩进一次(两个空格);  
3.对于属性的定义,确保全部使用双引号,绝不要使用单引号;  
4.不要在自闭合元素的尾部添加斜线--HTML5规范(https://dev.w3.org/html5/spec-author-view/syntax.html#syntax-start-tag)中明确说明这是可选的; 
5.不要省略可选的结束标签;
6.为每个HTML页面的第一行添加标准模式的声明,这样能确保在每个浏览器中有一只的展现;

二、语言属性:
根据HTML5规范,建议为HTML根元素指定 lang 属性,从而为文本设置正确的语言.这将有助于语音合成工具确定其应该采用的发音,有助于翻译工具确定翻译时应遵守的规则等等.lang 属性列表:http://www.sitepoint.com/web-foundations/iso-2-letter-language-codes/

三、IE兼容模式:  
IE支持通过特定的标签来确定回执当前页面所应该采用的IE版本.除非有强烈要求,否则最好是设置为edge mode,从而统治IE采用其所支持的最新的模式.

四、字符编码:
通过声明字符编码,能够确保浏览器快速并容易的判断页面内容的渲染方式.这样做可以避免在HTML中使用字符实体标记,从而全部与文档编码一致.

五、引入css和JavaScript文件:
根据HTML5规范,再引入css和JavaScript文件时一般不需要指定type属性,因为text/css和text/javascript分别是他们的默认值.

六、实用为王: 
尽量遵循HTML标准和语义,但是不要以牺牲实用性为代价.任何时候都要尽量使用最少的标签并保持最小的复杂度.

七、属性顺序:
HTML属性应当按照以下顺序依次排列,确保代码的易读性:
1.class
2.id,name    
3.data-*    
4.src,for,type,href    
5.title,alt    
6.Aria,role  
class用于标示高度可复用的组件,因此应该排在首位.

八、减少标签的数量
编写HTML代码时,尽量避免多余的父元素.很多时候,这需要迭代和重构来实现.

九、JavaScript生成的标签
通过JavaScript生成的标签让内容变得不易查找、编辑,并且境地性能.能避免是尽量避免.

十、CSS语法:
1.用两个空格来代替制表符(tab);  
2.为选择器分组时,将单独的选择器单独放在一行;  
3.为了代码的易读性,在每个声明块的左花括号钱添加一个空格;  
4.声明块的右花括号应该单独成行;  
5.每条声明语句的 : 后面应该插入一个空格;  
6.为了获得更准确的错误报告,每条声明都应该独占一行;  
7.所有声明语句都应该以分号结尾,最后一条声明语句后面的分号是可选的,但是如果省略这个分号,代码可能更容易出;  
8.对于以逗号分隔的属性值,每个逗号后面都应该插入一个空格;  
9.对于属性值或颜色参数,省略小于1的小数前面的0(例如 .5代替0.5);  
10.十六进制值应该全部小写,例如:#fff,尽量使用简写形式的十六进制值,例如用#fff代替#ffffff;  
11.为选择其中的属性添加双引号,例如 input[type="text"];  
12.避免为 0 值指定单位,例如用margin:0 代替margin:0px.

十一、声明顺序:

相关的属性声明应该归为一组,并且按照下面的顺序排列:   

1.positioning(position: absolute; top: 0; bottom: 0; right: 0; left: 0; z-index: 100;);   
2.box model(display: block; float: left; width: 100px; height: 100px;);   
3.typographic(font: normal 13px "Microsoft YaHei"; line-height: 1.5em; color: #333; text-align:center;);   
4.visual(background: yellow; border: 1px solid #c00; border-radius: 3px; opacity: 1; );
   
由于定位(positioning)可以从正常的文档流中移除元素,并且还能覆盖盒模型(box model)相关的样式,因此排在首位.盒模型排在第二位,因为他决定了组建的尺寸和位置.其他属性知识影响组建的内部(inside)或者是不影响前两组属性,因此排在后面.

十二、不要使用@import  
与标签相比,@import指令要慢很多,不光增加了额外的请求次数,还会导致不可预料的问题.替代办法有一下几种:
1.使用多个元素;     
2.通过sass或less类似的css预处理器将多个css文件便以为一个文件;     
3.通过rails、jekyll或者其他系统中提供过css文件合并功能.

十三、媒体查询(media query)的位置
将媒体查询尽可能放在相关规则的附近.不要将他们打包放在一个单一样式文件中或者放在文档底部.

十四、带前缀的属性: 
当使用特定厂商的带前缀的属性时,通过锁紧的方式,让每个属性的值在垂直方向对齐,这样方便多行编辑.例如:    

  1. <div style="display:none">
  2. <div class="login-box" id="login-dialog">
  3. <div class="login-top"><a class="current" rel="nofollow" id="login1" onclick="setTab('login',1,2);">登录</a></div>
  4. <div class="login-form" id="nav-signin">
  5. <!-- <div class="login-ico"><a rel="nofollow" class="qq" id="qqlogin" target="_blank" href="/user-center-qqlogin.html"> QQ </a></div> -->
  6. <div class="login-box-form" id="con_login_1">
  7. <form id="loginform" action="/user-center-login.html" method="post" onsubmit="return false;">
  8. <p class="int-text">
  9. <input class="email" id="username" name="username" type="text" value="用户名或Email" onfocus="if(this.value=='用户名或Email'){this.value='';}" onblur="if(this.value==''){this.value='用户名或Email';};"></p>
  10. <p class="int-text">
  11. <input class="password1" type="password" id="password" name="password" value="******" onblur="if(this.value=='') this.value='******';" onfocus="if(this.value=='******') this.value='';">
  12. </p>
  13. <p class="int-info">
  14. <label class="ui-label"> </label>
  15. <label for="agreement" class="ui-label-checkbox">
  16. <input type="checkbox" value="" name="cookietime" id="cookietime" checked="checked">
  17. <input type="hidden" name="notforward" id="notforward" value="1">
  18. <input type="hidden" name="dosubmit" id="dosubmit" value="1">记住我的登录 </label>
  19. <a rel="nofollow" class="aright" href="/user-center-forgetpwd.html" target="_blank"> 忘记密码? </a></p>
  20. <p class="int-btn"><a rel="nofollow" id="loginbt" class="loginbtn"><span>登录</span></a></p>
  21. </form>
  22. </div>
  23. <form id="regform" action="/user-center-reg.html" method="post">
  24. <div class="login-reg" style="display: none;" id="con_login_2">
  25. <input type="hidden" name="t" id="t">
  26. <p class="int-text">
  27. <input id="email" name="email" type="text" value="Email" onfocus="if(this.value=='Email'){this.value='';}" onblur="if(this.value==''){this.value='Email';};"></p>
  28. <p class="int-text">
  29. <input id="uname" name="username" type="text" value="用户名或昵称" onfocus="if(this.value=='用户名或昵称'){this.value='';}" onblur="if(this.value==''){this.value='用户名或昵称';};"></p>
  30. <p class="int-text">
  31. <input type="password" id="pwd" name="password" value="******" onblur="if(this.value=='') this.value='******';" onfocus="if(this.value=='******') this.value='';"> </p>
  32. <p class="int-text1"><span class="inputbox">
  33. <input id="validate" name="validate" type="text" value="验证码" onfocus="if(this.value=='验证码'){this.value='';}" onblur="if(this.value==''){this.value='验证码';};">
  34. </span><span class="yzm-img"><img src="/user-checkcode-index" alt="看不清楚换一张" id="indexlogin"></span></p>
  35. <p class="int-info">
  36. <label>
  37. <input value="" name="agreement" id="agreement" checked="checked" type="checkbox">
  38. 我已阅读<a rel="nofollow" href="/user-center-agreement.html">用户协议</a>及<a rel="nofollow" href="/user-center-agreement.html">版权声明</a></label>
  39. </p>
  40. <p class="int-btn"><input type="hidden" name="dosubmit">
  41. <a rel="nofollow" class="loginbtn" id="register"><span>注册</span></a></p>
  42. </div>
  43. </form>
  44. </div>
  45. </div>
  46. </div>