• 百度前端代码规范:HTML


    HTML

    1.代码风格

    1.1缩进与换行

    [强制] 使用 4 个空格做为一个缩进层级,不允许使用 2 个空格 或 tab 字符。

    <style>
    ul {
        padding: 0;
    }
    </style>
    
    <ul>
        <li>1</li>
        <li>2</li>
    <ul>

    [建议] 每行不得超过 120 个字符。

    1.2 命名

    [强制] class 必须单词全字母小写,单词间以 - 分隔。

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

    <!-- good -->
    <div class="slidebar">
        <div></div>
    </div>
    
    <!-- bad -->
    <div class="left">
        <div></div>
    </div>

    [强制] 元素 id 必须保证页面唯一。

    [建议] id 建议单词全字母小写,单词间以 - 分隔。同项目必须保持风格一致。

    [建议] idclass 命名,在避免冲突并描述清楚的前提下尽可能短。

    <!-- good -->
    <div id="nav"></div>
    
    <!-- bad -->
    <div id="navigation"></div>
    
    
    
    <!-- good -->
    <div id="author"></div>
    
    <!-- bad -->
    <div id="red"></div>

    [强制] 禁止为了 hook 脚本,创建无样式信息的 class

    不允许 class 只用于让 JavaScript 选择某些元素,class 应该具有明确的语义和样式。否则容易导致 CSS class 泛滥。

    使用 id 、属性选择作为 hook 是更好的方式。

    [强制] 同一页面,应避免使用相同的 name 与 id

    IE 浏览器会混淆元素的 id 和 name 属性, document.getElementById 可能获得不期望的元素。所以在对元素的 id 与 name属性的命名需要非常小心。

    一个比较好的实践是,为 id 和 name 使用不同的命名法。

    <input name="foo">
    <div id="foo"></div>
    <script>
    // IE6 将显示 INPUT
    alert(document.getElementById('foo').tagName);
    </script>

    1.3 标签

    [强制] 标签名必须使用小写字母。

    <!-- good -->
    <p>Hello StyleGuide!</p>
    
    <!-- bad -->
    <P>Hello StyleGuide!</P>

    [强制] 对于无需自闭合的标签,不允许自闭合。

    常见无需自闭合标签有 input  br  img  hr 等。

    <!-- good -->
    <input type="text" name="title">
    
    <!-- bad -->
    <input type="text" name="title" />

    [强制] 对 HTML5 中规定允许省略的闭合标签,不允许省略闭合标签。

    <!-- good -->
    <ul>
        <li>first</li>
        <li>second</li>
    </ul>
    
    <!-- bad -->
    <ul>
        <li>first
        <li>second
    </ul>

    [强制] 标签使用必须符合标签嵌套规则。

    比如 div 不得置于 p 中,tbody 必须置于 table 中。

    详细的标签嵌套规则参见HTML DTD中的 Elements 定义部分。

    [建议] HTML 标签的使用应该遵循标签的语义。

    [建议] 在 CSS 可以实现相同需求的情况下不得使用表格进行布局。

    [建议] 标签的使用应尽量简洁,减少不必要的标签。

    <!-- good -->
    <img class="avatar" src="image.png">
    
    <!-- bad -->
    <span class="avatar">
        <img src="image.png">
    </span>

     1.4 属性

    [强制] 属性名必须使用小写字母。

    <!-- good -->
    <table cellspacing="0">...</table>
    
    <!-- bad -->
    <table cellSpacing="0">...</table>

    [强制] 属性值必须用双引号包围。

    <!-- good -->
    <script src="esl.js"></script>
    
    <!-- bad -->
    <script src='esl.js'></script>
    <script src=esl.js></script>

    [建议] 布尔类型的属性,建议不添加属性值。

    <input type="text" disabled>
    <input type="checkbox" value="1" checked>

     

    [建议] 自定义属性建议以 xxx- 为前缀,推荐使用 data-

    <ol data-ui-type="Select"></ol>

    2.通用

    2.1 DOCTYPE

    [强制] 使用 HTML5 的 doctype 来启用标准模式,建议使用大写的 DOCTYPE

    <!DOCTYPE html>

    [建议] 启用 IE Edge 模式。

    <meta http-equiv="X-UA-Compatible" content="IE=Edge">

     

    [建议] 在 html 标签上设置正确的 lang 属性。

     有助于提高页面的可访问性,如:让语音合成工具确定其所应该采用的发音,令翻译工具确定其翻译语言等。

    <html lang="zh-CN">

    2.2 编码

    [强制] 页面必须使用精简形式,明确指定字符编码。指定字符编码的 meta 必须是 head 的第一个直接子元素。

    [建议] HTML 文件使用无 BOM 的 UTF-8 编码。

     UTF-8 编码具有更广泛的适应性。BOM 在使用程序或工具处理文件时可能造成不必要的干扰。

    2.3 CSS 和 JavaScript 引入

    [强制] 引入 CSS 时必须指明 rel="stylesheet"

    [建议] 引入 CSS 和 JavaScript 时无须指明 type 属性。

    [建议] 展现定义放置于外部 CSS 中,行为定义放置于外部 JavaScript 中。

     结构-样式-行为的代码分离,对于提高代码的可阅读性和维护性都有好处。

    [建议] 在 head 中引入页面需要的所有 CSS 资源。

     在页面渲染的过程中,新的CSS可能导致元素的样式重新计算和绘制,页面闪烁。

    [建议] JavaScript 应当放在页面末尾,或采用异步加载。

     将 script 放在页面中间将阻断页面的渲染。出于性能方面的考虑,如非必要,请遵守此条建议。

    3.head

    3.1 title

    [强制] 页面必须包含 title 标签声明标题。

    [强制] title 必须作为 head 的直接子元素,并紧随 charset 声明之后。

     title 中如果包含 ASCII 之外的字符,浏览器需要知道字符编码类型才能进行解码,否则可能导致乱码。

    3.2 favicon

    [强制] 保证 favicon 可访问。

    在未指定 favicon 时,大多数浏览器会请求 Web Server 根目录下的 favicon.ico 。为了保证 favicon 可访问,避免 404,必须遵循以下两种方法之一:

    1. 在 Web Server 根目录放置 favicon.ico 文件。
    2. 使用 link 指定 favicon。
    <link rel="shortcut icon" href="path/to/favicon.ico">

    3.3 viewport

    [建议] 若页面欲对移动设备友好,需指定页面的 viewport

    4.图片

    [强制] 禁止 img  src 取值为空。延迟加载的图片也要增加默认的 src 

     src 取值为空,会导致部分浏览器重新加载一次当前页面

    [建议] 避免为 img 添加不必要的 title 属性。

    多余的 title 影响看图体验,并且增加了页面尺寸。

    [建议] 为重要图片添加 alt 属性。

    可以提高图片加载失败时的用户体验。

    [建议] 添加  width  和  height  属性,以避免页面抖动。

    [建议] 有下载需求的图片采用 img 标签实现,无下载需求的图片采用 CSS 背景图实现。

    1. 产品 logo、用户头像、用户产生的图片等有潜在下载需求的图片,以 img 形式实现,能方便用户下载。
    2. 无下载需求的图片,比如:icon、背景、代码使用的图片等,尽可能采用 CSS 背景图实现。

    5.表单

    5.1 控件标题

    [强制] 有文本标题的控件必须使用 label 标签将其与其标题相关联

    解释:

    有两种方式:

    1. 将控件置于 label 内。
    2. label 的 for 属性指向控件的 id

    推荐使用第一种,减少不必要的 id。如果 DOM 结构不允许直接嵌套,则应使用第二种。

    <label><input type="checkbox" name="confirm" value="on"> 我已确认上述条款</label>
    
    <label for="username">用户名:</label> <input type="textbox" name="username" id="username">

    5.2 按钮

    [强制] 使用 button 元素时必须指明 type 属性值。

    button 元素的默认 type 为 submit,如果被置于 form 元素中,点击后将导致表单提交。为显示区分其作用方便理解,必须给出 type 属性。

    <button type="submit">提交</button>
    <button type="button">取消</button>

    [建议] 尽量不要使用按钮类元素的 name 属性。

    由于浏览器兼容性问题,使用按钮的 name 属性会带来许多难以发现的问题。

    5.3 可访问性 (A11Y)

    [建议] 负责主要功能的按钮在 DOM 中的顺序应靠前。

     负责主要功能的按钮应相对靠前,以提高可访问性。如果在 CSS 中指定了 float: right 则可能导致视觉上主按钮在前,而 DOM 中主按钮靠后的情况。

    <!-- good -->
    <style>
    .buttons .button-group {
        float: right;
    }
    </style>
    
    <div class="buttons">
        <div class="button-group">
            <button type="submit">提交</button>
            <button type="button">取消</button>
        </div>
    </div>
    
    <!-- bad -->
    <style>
    .buttons button {
        float: right;
    }
    </style>
    
    <div class="buttons">
        <button type="button">取消</button>
        <button type="submit">提交</button>
    </div>

    [建议] 当使用 JavaScript 进行表单提交时,如果条件允许,应使原生提交功能正常工作。

    当浏览器 JS 运行错误或关闭 JS 时,提交功能将无法工作。如果正确指定了 form 元素的 action 属性和表单控件的 name 属性时,提交仍可继续进行。

    <form action="/login" method="post">
        <p><input name="username" type="text" placeholder="用户名"></p>
        <p><input name="password" type="password" placeholder="密码"></p>
    </form>

    [建议] 在针对移动设备开发的页面时,根据内容类型指定输入框的 type 属性。

    根据内容类型指定输入框类型,能获得能友好的输入体验。

    <input type="date">

    6.多媒体

    [建议] 当在现代浏览器中使用 audio 以及 video 标签来播放音频、视频时,应当注意格式。

    音频应尽可能覆盖到如下格式:

    • MP3
    • WAV
    • Ogg

    视频应尽可能覆盖到如下格式:

    • MP4
    • WebM
    • Ogg

    [建议] 在支持 HTML5 的浏览器中优先使用 audio 和 video 标签来定义音视频元素。

    [建议] 使用退化到插件的方式来对多浏览器进行支持。

    <audio controls>
        <source src="audio.mp3" type="audio/mpeg">
        <source src="audio.ogg" type="audio/ogg">
        <object width="100" height="50" data="audio.mp3">
            <embed width="100" height="50" src="audio.swf">
        </object>
    </audio>
    
    <video width="100" height="50" controls>
        <source src="video.mp4" type="video/mp4">
        <source src="video.ogg" type="video/ogg">
        <object width="100" height="50" data="video.mp4">
            <embed width="100" height="50" src="video.swf">
        </object>
    </video>

    [建议] 只在必要的时候开启音视频的自动播放。

    [建议] 在 object 标签内部提供指示浏览器不支持该标签的说明。

    <object width="100" height="50" data="something.swf">DO NOT SUPPORT THIS TAG</object>

    7.模板中的 HTML

    [建议] 模板代码的缩进优先保证 HTML 代码的缩进规则。

    [建议] 模板代码应以保证 HTML 单个标签语法的正确性为基本原则。

    [建议] 在循环处理模板数据构造表格时,若要求每行输出固定的个数,建议先将数据分组,之后再循环输出。

    <!-- good -->
    <table>
        {foreach $item_list as $item_group}
        <tr>
            {foreach $item_group as $item}
            <td>{ $item.name }</td>
            {/foreach}
        <tr>
        {/foreach}
    </table>
    
    <!-- bad -->
    <table>
    <tr>
        {foreach $item_list as $item}
        <td>{ $item.name }</td>
            {if $item@iteration is div by 5}
        </tr>
        <tr>
            {/if}
        {/foreach}
    </tr>
    </table>

    摘自:https://zhuanlan.zhihu.com/p/19884834

  • 相关阅读:
    0101-ioc
    通过Android studio手动触发Android 上层GC(垃圾回收)的方法
    【Win10】BeyondCompare时提示"许可证密钥已被撤销"的解决办法
    Android Historian安装使用
    初探OpenCL之Mac OS上的hello world示例
    python画高斯分布图形
    深度学习优化算法总结
    《用Python玩转数据》项目—线性回归分析入门之波士顿房价预测(二)
    《用Python玩转数据》项目—线性回归分析入门之波士顿房价预测(一)
    (转)导数、偏导数、方向导数、梯度、梯度下降
  • 原文地址:https://www.cnblogs.com/namehou/p/10484329.html
Copyright © 2020-2023  润新知