freemarker html 引入script_HTML编码规范

一、前言HTML作为描述网页结构的超文本标记语言，在百度一直有着广泛的应用。本文档的目标是使HTML代码风格保持一致，容易被理解和被维护。

二、代码风格

2.1. 缩进与换行

​

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

示例

<ul>

<li>first</li>

<li>second</li>

</ul>

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

解释：

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

2.2. 命名

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

示例

<!-- good -->

<div class="sidebar"></div>

<!-- bad -->

<div class="left"></div>

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

解释：

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

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

示例

<!-- good -->

<div id="nav"></div>

<!-- bad -->

<div id="navigation"></div>

<!-- good -->

<p class="comment"></p>

<!-- bad -->

<p class="com"></p>

<!-- good -->

<span class="author"></span>

<!-- bad -->

<span class="red"></span>

  • [强制] 禁止为了 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>

2.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 标签的使用应该遵循标签的语义。

解释：

下面是常见标签语义

  • p - 段落
  • h1,h2,h3,h4,h5,h6 - 层级标题
  • strong,em - 强调
  • ins - 插入
  • del - 删除
  • abbr - 缩写
  • code - 代码标识
  • cite - 引述来源作品的标题
  • q - 引用
  • blockquote - 一段或长篇引用
  • ul - 无序列表
  • ol - 有序列表
  • dl,dt,dd - 定义列表

示例

<!-- good -->

<p>Esprima serves as an important <strong>building block</strong> for some JavaScript language tools.</p>

<!-- bad -->

<div>Esprima serves as an important <span class="strong">building block</span> for some JavaScript language tools.</div>

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

解释：

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

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

示例

<!-- good -->

<img class="avatar" src="image.png">

<!-- bad -->

<span class="avatar">

<img src="image.png">

</span>

2.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>

三、通用

3.1. DOCTYPE

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

示例

<!DOCTYPE html>

  • [建议] 启用 IE Edge 模式。

示例

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

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

解释：

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

示例

<html lang="zh-CN">

3.2. 编码

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

示例

<html>

<head>

<meta charset="UTF-8">

......

</head>

<body>

......

</body>

</html>

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

解释：

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

3.3. CSS和JavaScript引入

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

示例

<link rel="stylesheet" src="page.css">

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

解释：

text/css和text/javascript是type的默认值。

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

解释：

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

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

解释：

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

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

解释：

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

示例

<body>

<!-- a lot of elements -->

<script src="init-behavior.js"></script>

</body>

  • [建议] 移动环境或只针对现代浏览器设计的 Web 应用，如果引用外部资源的URL协议部分与

页面相同，建议省略协议前缀。

解释：

使用protocol-relativeURL引入CSS，在IE7/8下，会发两次请求。是否使用protocol-relativeURL应充分考虑页面针对的环境。

示例

<script src="//s1.bdstatic.com/cache/static/jquery-1.10.2.min_f2fb5194.js"></script>

四、 head

4.1. title

  • [强制] 页面必须包含 title 标签声明标题。
  • [强制] title 必须作为 head 的直接子元素，并紧随 charset 声明之后。

解释：

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

示例

<head>

<meta charset="UTF-8">

<title>页面标题</title>

</head>

4.2. favicon

  • [强制] 保证 favicon 可访问。

解释：

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

  • 在 Web Server 根目录放置 favicon.ico 文件。
  • 使用 link 指定 favicon。

示例

<link rel="shortcut icon" href="path/to/favicon.ico">

4.3. viewport

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

解释:

viewport meta tag可以设置可视区域的宽度和初始缩放大小，避免在移动设备上出现页面展示不正常。

比如，在页面宽度小于 980px 时，若需 iOS 设备友好，应当设置 viewport 的 width 值来适应你的页面宽度。同时因为不同移动设备分辨率不同，在设置时，应当使用 device-width 和 device-height 变量。

另外，为了使 viewport 正常工作，在页面内容样式布局设计上也要做相应调整，如避免绝对定位等。关于 viewport 的更多介绍，可以参见 Safari Web Content Guide的介绍

五、图片

  • [强制] 禁止 img 的 src 取值为空。延迟加载的图片也要增加默认的 src。
  • [建议] 避免为 img 添加不必要的 title 属性。

解释:

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

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

解释:

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

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

解释:

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

六、表单

6.1. 控件标题

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

解释:

有两种方式：

  • 将控件置于 label 内。
  • 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">

6.2. 按钮

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

解释:

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

示例

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

<button type="button">取消</button>

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

6.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">

七、多媒体

  • [建议] 当在现代浏览器中使用 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>

八、模板中的 HTML

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

示例

<!-- good -->

{if $display == true}

<div>

<ul>

{foreach $item_list as $item}

<li>{$item.name}<li>

{/foreach}

</ul>

</div>

{/if}

<!-- bad -->

{if $display == true}

<div>

<ul>

{foreach $item_list as $item}

<li>{$item.name}<li>

{/foreach}

</ul>

</div>

{/if}

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

示例

<!-- good -->

<li class="{if $item.type_id == $current_type}focus{/if}">{ $item.type_name }</li>

<!-- bad -->

<li {if $item.type_id == $current_type} class="focus"{/if}>{ $item.type_name }</li>

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

示例

<!-- 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>

f22ffd38d8010f8c4bc7856d8c1707e0.png
公众号：电脑资讯

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.mzph.cn/news/381463.shtml

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

python制作词典_我的词典我做主！python3.5生成自己的词性词典

python制作词典_我的词典我做主！python3.5生成自己的词性词典

由于朋友需要做文本分析&#xff0c;前提是要将文本中的名词和动词剔除掉&#xff0c;但没有现成的名词和动词的txt格式的词典。于是找来了一个英汉词典&#xff0c;根据每一行出现的adj、adv、n、prep等&#xff0c;使用正则表达式匹配需要的词性&#xff0c;并将其追加写入到…
阅读更多...
微软的几个职位简介

微软的几个职位简介

说起来比较惭愧&#xff0c;自己混微软圈子也不短了&#xff0c;但是今天还是第一次认真思考微软的这几个比较常用的职位&#xff0c;SDE、SDET、PM&#xff0c;仅供参考下&#xff0c;网上查的&#xff0c;如果有不对或者不全面的地方&#xff0c;欢迎指教 Dev&#xff1a;正式…
阅读更多...
写入null_ArrayList并发写出现Null值

写入null_ArrayList并发写出现Null值

ArrayList并非线程安全的容器&#xff0c;这一点大家可能都非常清楚&#xff0c;但是在并发写入的情况下&#xff0c;不安全的情况具体有哪些&#xff0c;大家是否很清楚呢&#xff1f;本篇文章重点聊一下出现null的情况&#xff0c;然后对于其他并发写的安全做一个简单的叙述我…
阅读更多...
c语言函数调用数组_第七讲：C语言基础之函数，第二节，实现汉诺塔

c语言函数调用数组_第七讲：C语言基础之函数，第二节，实现汉诺塔

本文约2200字&#xff0c;主要讲了C语言基础之函数&#xff0c;递归&#xff0c;数组作为函数参数以及案例、练习题等。带你进入C语言的世界&#xff0c;入门C语言&#xff0c;后边将持续更新。可以收藏学习。想了解C语言基础之函数&#xff0c;函数的基本概述&#xff0c;函数…
阅读更多...
当代国人绝难做到的10件平常事

当代国人绝难做到的10件平常事

1、在饭厅中保持低声。无论是在家中&#xff0c;还是在大饭店吃饭&#xff0c;中国人总爱高声喧哗&#xff0c;如果是饮酒&#xff0c;还会扯酒皮&#xff0c;猜拳行令&#xff0c;完全不把旁人放在眼中。因而&#xff0c;在中国&#xff0c;也没有人觉得饭厅噪音得治一治。事实…
阅读更多...
仍然报错_only_full_group_by配置，竟让所有应用报错？

仍然报错_only_full_group_by配置，竟让所有应用报错？

推荐学习周一福利到&#xff01;献上“独家全新”MySQL进阶套餐&#xff0c;简直就是血赚 全网独家的“MySQL高级知识”集合&#xff0c;骨灰级收藏&#xff0c;手慢则无 1. 踩坑经历一个很平常的下午&#xff0c;大家都在埋头认真写bug呢&#xff0c;突然企业微信群里炸锅了&a…
阅读更多...
根据录入的计算公式计算_污水处理工程设计入门（10）—堰口计算

根据录入的计算公式计算_污水处理工程设计入门（10）—堰口计算

呓语&#xff1a;虽然现在很多人会推送很多的快速计算表格&#xff0c;但是我并不想授人以鱼。我希望每一个想学习想入门做污水处理工程设计的人先看懂如何设计&#xff0c;再去想如何快速计算&#xff0c;再去想怎么改进。再者&#xff0c;想想有一天你当领导审图了&#xff0…
阅读更多...
DNN SEO专题 (收集)

DNN SEO专题 (收集)

SEO, 是Search Engine Optimization的缩写, 翻译过来是“搜索引擎优化", 直白说就是“针对搜索引擎所做的优化处理工作”。 是一种利用搜索引擎的搜索规则来提高目的网站在有关搜索引擎( Google, Baidu, Live Search 等) 内提名的方式。它可以给你的网站带来更多的客户访问…
阅读更多...
发送请求_发送soap请求调用WSDL

发送请求_发送soap请求调用WSDL

");soap.Append("");soap.Append("");soap.Append("XX系统");soap.Append("");soap.Append(DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss"));soap.Append("");soap.Append("{"LoginName":&qu…
阅读更多...
递归函数python有什么特点_Python中的递归

递归函数python有什么特点_Python中的递归

在前面的讲解中&#xff0c;函数的调用通常发生在彼此不同的函数之间。其实&#xff0c;函数还有一种特殊的调用方式&#xff0c;那就是自己调用自己&#xff0c;这种方式称为函数递归调用。 递归&#xff0c;在程序设计中也是一个常用的技巧&#xff0c;甚至是一种思维方式&am…
阅读更多...
XML基本知识（三）

XML基本知识（三）

XML语法(3)--属性、声明符号、字符数据、注释 属性&#xff1a;提供元素的附加信息。 属性是元素开始标签的一部分。eg: <para keywords"Napoleon,France,history">...</para>注意: 属性由“名”和“值”组成&#xff0c;中间有“”分隔。值由引号包括…
阅读更多...
apache实验报告 linux_Linux实验报告

apache实验报告 linux_Linux实验报告

Linux实验报告-源代码编译安装Apache(Tarball文件安装)实验背景&#xff1a;通常GNU组织提供的程序包都是源代码格式&#xff0c;即将软件的所有源码文件先以tar打包&#xff0c;然后再使用gizp或是bzip2压缩&#xff0c;生成一个.tar.gz或是.tar.bz2结尾的软件包&#xff0c;也…
阅读更多...
python合并两个文本文件内容_用Python 将两个文件的内容合并成一个新的文件.

python合并两个文本文件内容_用Python 将两个文件的内容合并成一个新的文件.

一个文件的内容是: Introduction to Programming, Networking Fundamentals, Internetworking Technologies, Platform Technologies, Information Technology for Users, Computer Forensics, Enterprise Networks, Database Technologies 还有一个是: BN108, MN401, MN503, B…
阅读更多...
设备场景函数——72个

设备场景函数——72个

说明&#xff1a;本类 API 函数&#xff0c;内容均摘自网络&#xff0c;版权归实际作者所有。 CombineRgn 将两个区域组合为一个新区域 CombineTransform 驱动世界转换。它相当于依顺序进行两次转换 CreateCompatibleDC 创建一个与特定设备场景一致的内存设备场景 CreateDC,Cre…
阅读更多...
安卓手机突然很卡_你的安卓手机越来越卡？教你4招轻松解决问题！

安卓手机突然很卡_你的安卓手机越来越卡？教你4招轻松解决问题！

原标题&#xff1a;你的安卓手机越来越卡&#xff1f;教你4招轻松解决问题&#xff01;现在我们对于手机的使用时间不会特别的长&#xff0c;所以这个更换的速度就比较快。其实是很多的用户换手机是因为比较喜欢用新的手机体验新的科技&#xff0c;不过也还是有很多的用户不是因…
阅读更多...
python 导入自己写的类_python中自己的类不能被导入

python 导入自己写的类_python中自己的类不能被导入

我自己编写了一个类 class Settings(): def __init__(self): self.screen_width1200 self.screen_height800 self.bg_color(230,230,230) 然后我想在引用 import sys import pygame from settings import Settings def run_game(): pygame.init() ai_settingsSettings() screen…
阅读更多...
关于使用在webforms里使用routing遇到的问题

关于使用在webforms里使用routing遇到的问题

看了重典的两篇文章 System.Web.Routing入门及进阶　上篇 System.Web.Routing入门及进阶　下篇 仿照其中的进行了操作&#xff0c;发现怎么不都起作用&#xff0c;非常奇怪&#xff0c;搜了好多才找到了解决方案 是在MSDN上找到的&#xff0c;如下&#xff1a; To configure …
阅读更多...
python调用父类构造函数需要放在第一句吗_Python继承和调用父类构造函数

python调用父类构造函数需要放在第一句吗_Python继承和调用父类构造函数

这是我正在Python中做的&#xff1a;class BaseClass:def __init__(self):print The base class constructor ran!self.__test 42class ChildClass(BaseClass):def __init__(self):print The child class constructor ran!BaseClass.__init__(self)def doSomething(self):prin…
阅读更多...
python千位分隔符_python – 为pandas数据帧中的整数设置千位分隔符

python千位分隔符_python – 为pandas数据帧中的整数设置千位分隔符

我正在尝试使用{&#xff1a;,}’.格式(数字),如下例所示,格式化pandas数据帧中的数字&#xff1a; # This works for floats and integers print {:,}.format(20000) # 20,000 print {:,}.format(20000.0) # 20,000.0 问题是,对于具有整数的数据帧不起作用,并且在具有float的数…
阅读更多...
[导入]【翻译】WF从入门到精通（第十章）：事件活动

[导入]【翻译】WF从入门到精通（第十章）：事件活动

摘要: 学习完本章&#xff0c;你将掌握&#xff1a;1.使用HandleExtenalEvent活动创建特定的事件处理程序2.在你的工作流中使用Delay活动3.在你的工作流中使用EventDriven活动4.在你的工作流中使用Listen活动5.理解EventHandlingScope活动在活动并发执行的情况下是怎样监听事件…
阅读更多...
最新文章

Copyright @ 2022~2023