HTML编码规范建议

sunnyxd 发布于2019-08-01 17:02 / 1697人阅读

摘要：示例强制对中规定允许省略的闭合标签，不允许省略闭合标签。示例图片强制禁止的取值为空。示例提交取消取消提交建议当使用进行表单提交时，如果条件允许，应使原生提交功能正常工作。示例建议模板代码应以保证单个标签语法的正确性为基本原则。

这段时间在整理前端部分代码规范，初步想法是从HTML、CSS、Javascipt、项目文件目录四部分是整理。之前已经整理完了CSS编码规范，有兴趣可以了解下

1. 代码风格 1.1缩进与换行 [强制] 使用 4 个空格做为一个缩进层级，不允许使用 2 个空格或 tab 字符。

解释：
对于非 HTML 标签之间的缩进，比如 script 或 style 标签内容缩进，与 script 或 style 标签的缩进同级。
示例：



    first
    second

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

解释：
过长的代码不容易阅读与维护。但是考虑到 HTML 的特殊性，不做硬性要求。

1.2命名 [强制] class 必须单词全字母小写，单词间以 - 分隔。 [强制] class 必须代表相应模块或部件的内容或功能，不得以样式信息进行命名。

示例：

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

解释：
同一个页面中，不同的元素包含相同的 id，不符合 id 的属性含义。并且使用 document.getElementById 时可能导致难以追查的问题。

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

解释：
不允许 class 只用于让 JavaScript 选择某些元素，class 应该具有明确的语义和样式。否则容易导致 CSS class 泛滥。
使用 id、属性选择作为 hook 是更好的方式。

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

解释：
IE 浏览器会混淆元素的 id 和 name 属性， document.getElementById 可能获得不期望的元素。所以在对元素的 id 与 name属性的命名需要非常小心。
一个比较好的实践是，为 id 和 name 使用不同的命名法。
示例：

[建议] id 建议单词全字母小写，单词间以 _ 分隔。同项目必须保持风格一致。 [建议] id、class 命名，在避免冲突并描述清楚的前提下尽可能短。

示例：

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

示例：

Hello StyleGuide!

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

解释：
常见无需自闭合标签有 input、br、img等。
示例：

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

解释：
对代码体积要求非常严苛的场景，可以例外。比如：第三方页面使用的投放系统。
示例：



    first
    second



    first
    
second

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

解释：
比如 div 不得置于 p 中，tbody 必须置于 table 中。
详细的标签嵌套规则参见HTML DTD中的 Elements 定义部分。

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

解释：
下面是常见标签语义

p - 段落

h1,h2,h3,h4,h5,h6 - 层级标题

strong,em - 强调

abbr - 缩写

blockquote - 一段或长篇引用

ul - 无序列表

ol - 有序列表

dl,dt,dd - 定义列表

示例：

Esprima serves as an important building block for some JavaScript language tools.

Esprima serves as an important building block for some JavaScript language tools.

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

解释：
在兼容性允许的情况下应尽量保持语义正确性。对网格对齐和拉伸性有严格要求的场景允许例外，如多列复杂表单。

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

示例：

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

解释：
src 取值为空，会导致部分浏览器重新加载一次当前页面，参考：https://developer.yahoo.com/performance/rules.html#emptysrc

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

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

[建议] 添加 width 和 height 属性，以避免页面抖动。 [建议] 有下载需求的图片采用 img 标签实现，无下载需求的图片采用 CSS 背景图实现。

解释：

产品 logo、用户头像、用户产生的图片等有潜在下载需求的图片，以 img 形式实现，能方便用户下载。

无下载需求的图片，比如：icon、背景、代码使用的图片等，尽可能采用 CSS 背景图实现。

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

解释：
有两种方式：

将控件置于 label 内。

label 的 for 属性指向控件的 id。

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

 我已确认上述条款
用户名：

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

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

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

解释：
由于浏览器兼容性问题，使用按钮的 name 属性会带来许多难以发现的问题。具体情况可参考此文

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

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

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

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

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

解释：
根据内容类型指定输入框类型，能获得能友好的输入体验。
示例：

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

解释：
音频应尽可能覆盖到如下格式：

MP3

WAV

Ogg

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

MP4

WebM

Ogg

[建议] 在支持 HTML5 的浏览器中优先使用 audio 和 video 标签来定义音视频元素。 [建议] 只在必要的时候开启音视频的自动播放。 [建议] 在 object 标签内部提供指示浏览器不支持该标签的说明。

示例：

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

示例：


{if $display == true}

    
    {foreach $item_list as $item}
        {$item.name}

    {/foreach}
    

{/if}

{if $display == true}
    
        
    {foreach $item_list as $item}
        {$item.name}

    {/foreach}
        
    
{/if}

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

示例：


{ $item.type_name }

{ $item.type_name }

云服务器 GPU云服务器规范编码编码规范 php编码规范 js安全编码规范

文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。

转载请注明本文地址：https://www.ucloud.cn/yun/50907.html

HTML编码规范

摘要：当然我们还可以引入框架，这些框架一般都自带模板处理引擎，比如等语义化命名和语义化标签我们尽量多采用语义化来命名，并且采用语义化标签来书写代码，多用中新增的标签来书写。 1.黄金法则（Golden rule）不管有多少人参与同一个项目，一定要确保每一行代码都像是同一个人编写的。 Every line of code should appear to be written by a si...

nifhlheimr 2019-08-01 14:50 评论0 收藏0
HTML编码规范

摘要：示例强制禁止为了脚本，创建无样式信息的。示例强制对中规定允许省略的闭合标签，不允许省略闭合标签。指定字符编码的必须是的第一个直接子元素。示例提交取消取消提交建议当使用进行表单提交时，如果条件允许，应使原生提交功能正常工作。转载：原地址 1 前言 HTML作为描述网页结构的超文本标记语言，在百度一直有着广泛的应用。本文档的目标是使HTML代码风格保持一致，容易被理解和被维护。 2 代码...

bang590 2019-08-01 14:43 评论0 收藏0
编码规范 —— 编写灵活、稳定、高质量的 HTML 和 CSS 代码的规范

摘要：用两个空格代替制表符这是唯一能保证在所有环境下获得一致展现的方法。编辑器配置将你的编辑器按照下面的配置进行设置，以免常见的代码不一致和差异用两个空格代替制表符保存文件时删除尾部的空白符设置文件编码为在文件结尾添加一个空白行。黄金定律永远遵循同一套编码规范 - 可以是这里列出的，也可以是你自己总结的。如果发现规范中有任何错误，敬请指正。 HTML 语法用两个空格代替制表符 (ta...

Karuru 2019-08-01 14:41 评论0 收藏0
JavaScript编码规范 2

摘要：指定参数为可以获得所有子元素。如需多次操作同一集合，则应将集合转为数组。示例显示为显示为建议获取元素的直接子元素时使用。建议尽量减少操作。事件建议优先使用绑定事件，避免直接在属性中或的属性绑定事件处理。而的仅支持冒泡的事件触发。转载：原地址 4 浏览器环境 4.1 模块化 4.1.1 AMD [强制] 使用 AMD 作为模块定义。解释： AMD 作为由社区认可的模块定义...

yankeys 2019-08-21 12:37 评论0 收藏0