HTML 编码规约

基本规约

  • 在每个 HTML 页面开头使用这个简单地 doctype 来启用标准模式,使其每个浏览器中尽可能一致的展现。



  
  





  
  

  • 统一使用 UTF-8 字符编码

  • Internet Explorer 支持使用兼容性 标签来指定使用什么版本的 IE 来渲染页面。如果不是特殊需要,通常通过 edge mode 来通知 IE 使用最新的兼容模式。


  • 根据 HTML5 规约, 通常在引入 CSS 和 JavaScript 时不需要指明 type,因为 text/css 和 text/javascript 分别是他们的默认值。



  
  





  
  

  • 引入 CSS 必须在 标签里引入。对于引入 Javascript,除了基础库等比较基础性的脚本文件,其他都在靠近 body 结束标签前面引入。



  
    
    
  
  
      
  





  
    
    
  
  
  

  • 【建议】缩进使用两个空格

just a example

just a example

  • 标签名称和标签属性统一使用小写

  • 建议的 html 脚手架


  
    
    
    
    
    
    
    淘宝网
    
  
  
      
  

属性规约

  • 属性引号用双引号





  • 尽量不要为 Boolean 属性添加取值。













  • 建议自定义属性必须以 data- 为前缀,便于阅读。


  Example link




  Example link

  • HTML 属性应该按照特定的顺序出现以保证易读性
    class
    id, name
    data-*
    ...
    Classes 是为高可复用组件设计的,所以他们处在第一位。Ids 更加具体而且应该尽量少使用(例如, 页内书签),所以他们处在第二位。


  Example link






  Example link



标签规约

【建议】不要在自动闭合标签的结尾处使用斜线,如


命名规约

  • 对于需要自定义属性,属性名命名统一使用 data- 前缀
  • id 命名,当作为 JS 钩子使用 时,以 J_ 为前缀,后面接大驼峰命名,且这类选择器不能出现在 css 中,例如 J_ExampleIdForJs。其他使用用法,例如充当锚点,label 对应 input 的 id,都正常默认使用即可。

多媒体退化

  • img标签添加alt 属性以声明替代文本;
  • 在多媒体标签内部提供指示浏览器不支持该标签的说明,如object、audio、video





注释规约

由于 html 代码一般不会经过预处理,出于安全考虑,html 代码中不能出现任何关于业务相关敏感信息的注释。

你可能感兴趣的:(HTML 编码规约)