HTML(5) 代码规范


HTML 代码约定

很多 Web 开发人员对 HTML 的代码规范知之甚少。

在2000年至2010年,许多Web开发人员从 HTML 转换到 XHTML。

使用 XHTML 开发人员逐渐养成了比较好的 HTML 编写规范。

而针对于 HTML5 ,我们应该形成比较好的代码规范,以下提供了几种规范的建议。


使用正确的文档类型

文档类型声明位于HTML文档的第一行:

<!DOCTYPE html>

如果你想跟其他标签一样使用小写,可以使用以下代码:

<!doctype html>

使用小写元素名

HTML5 元素名可以使用大写和小写字母。

推荐使用小写字母:

  • 混合了大小写的风格是非常糟糕的。
  • 开发人员通常使用小写 (类似 XHTML)。
  • 小写风格看起来更加清爽。
  • 小写字母容易编写。

不推荐:

<SECTION>
  <p>这是一个段落。</p>
</SECTION>

非常糟糕:

<Section>
  <p>这是一个段落。</p>
</SECTION>

推荐:

<section>
  <p>这是一个段落。</p>
</section>

关闭所有 HTML 元素

在 HTML5 中, 你不一定要关闭所有元素 (例如

元素),但我们建议每个元素都要添加关闭标签。

不推荐:

<section>
  <p>这是一个段落。
  <p>这是一个段落。
</section>

推荐:

<section>
  <p>这是一个段落。</p>
  <p>这是一个段落。</p>
</section>

关闭空的 HTML 元素

在 HTML5 中, 空的 HTML 元素也不一定要关闭:

我们可以这么写:

<meta charset="utf-8">

也可以这么写:

<meta charset="utf-8" />

在 XHTML 和 XML 中斜线 (/) 是必须的。

如果你期望 XML 软件使用你的页面,使用这种风格是非常好的。


使用小写属性名

HTML5 属性名允许使用大写和小写字母。

我们推荐使用小写字母属性名:

  • 同时使用大小写是非常不好的习惯。
  • 开发人员通常使用小写 (类似 XHTML)。
  • 小写风格看起来更加清爽。
  • 小写字母容易编写。

不推荐:

<div CLASS="menu">

推荐:

<div class="menu">

属性值

HTML5 属性值可以不用引号。

属性值我们推荐使用引号:

  • 如果属性值含有空格需要使用引号。
  • 混合风格不推荐的,建议统一风格。
  • 属性值使用引号易于阅读。

以下实例属性值包含空格,没有使用引号,所以不能起作用:

<table class=table striped>

以下使用了双引号,是正确的:

<table class="table striped">

图片属性

图片通常使用 alt 属性。 在图片不能显示时,它能替代图片显示。

<img src="html5.gif" alt="HTML5">

定义好图片的尺寸,在加载时可以预留指定空间,减少闪烁。

<img src="html5.gif" alt="HTML5" style="width:128px;height:128px">

空格和等号

等号前后可以使用空格。

<link rel = "stylesheet" href = "styles.css">

但我们推荐少用空格:

<link rel="stylesheet" href="styles.css">

避免一行代码过长

使用 HTML 编辑器,左右滚动代码是不方便的。

每行代码尽量少于 80 个字符。


空行和缩进

不要无缘无故添加空行。

为每个逻辑功能块添加空行,这样更易于阅读。

缩进使用两个空格,不建议使用 TAB。

比较短的代码间不要使用不必要的空行和缩进。

不必要的空行和缩进:

<body>

  <h1>菜鸟教程</h1>

  <h2>HTML</h2>

  <p>
    菜鸟教程,学的不仅是技术,更是梦想。
    菜鸟教程,学的不仅是技术,更是梦想。
   菜鸟教程,学的不仅是技术,更是梦想,
    菜鸟教程,学的不仅是技术,更是梦想。
  </p>

</body>

推荐:

<body>

<h1>菜鸟教程</h1>

<h2></h2>
<p>菜鸟教程,学的不仅是技术,更是梦想。
菜鸟教程,学的不仅是技术,更是梦想。
菜鸟教程,学的不仅是技术,更是梦想。
菜鸟教程,学的不仅是技术,更是梦想。</p>

</body>

表格实例:

<table>
  <tr>
    <th>Name</th>
    <th>Description</th>
  </tr>
  <tr>
    <td>A</td>
    <td>Description of A</td>
  </tr>
  <tr>
    <td>B</td>
    <td>Description of B</td>
  </tr>
</table>

列表实例:

<ol>
  <li>London</li>
  <li>Paris</li>
  <li>Tokyo</li>
</ol>

省略 和 ?

在标准 HTML5 中, 和 标签是可以省略的。

以下 HTML5 文档是正确的:

实例:

<!DOCTYPE html>
<head>
  <title>页面标题</title>
</head>

<h1>这是一个标题</h1>
<p>这是一个段落。</p>

尝试一下 »

不推荐省略 和 标签。

元素是文档的根元素,用于描述页面的语言:

<!DOCTYPE html>
<html lang="zh">

声明语言是为了方便屏幕阅读器及搜索引擎。

省略 或 在 DOM 和 XML 软件中会崩溃。

省略 在旧版浏览器 (IE9)会发生错误。


省略 ?

在标准 HTML5 中, 标签是可以省略的。

默认情况下,浏览器会将 之前的内容添加到一个默认的 元素上。

实例

<!DOCTYPE html>
<html>
<title>页面标题</title>

<body>
  <h1>这是一个标题</h1>
  <p>这是一个段落。</p>
</body>

</html>

尝试一下 »
Note 现在省略 head 标签还不推荐使用。

元数据

HTML5 中 元素是必须的,标题名描述了页面的主题:</p> <div class="example"> <div class="example_code"> <span class="highLT"><</span><span class="highELE">title</span><span class="highGT">></span>菜鸟教程<span class="highLT"><</span><span class="highELE">/title</span><span class="highGT">></span></div> </div> <p>标题和语言可以让搜索引擎很快了解你页面的主题:</p> <div class="example"> <div class="example_code"> <span class="highLT"><</span><span class="highELE">!DOCTYPE</span> <span class="highATT">html</span><span class="highGT">></span><br><span class="highLT"><</span><span class="highELE">html</span> <span class="highATT">lang=</span><span class="highVAL">"zh"</span><span class="highGT">></span><br><span class="highLT"><</span><span class="highELE">head</span><span class="highGT">></span><br>  <span class="highLT"><</span><span class="highELE">meta</span> <span class="highATT">charset=</span><span class="highVAL">"UTF-8"</span><span class="highGT">></span><br>  <span class="highLT"><</span><span class="highELE">title</span><span class="highGT">></span>菜鸟教程<span class="highLT"><</span><span class="highELE">/title</span><span class="highGT">></span><br><span class="highLT"><</span><span class="highELE">/head</span><span class="highGT">></span></div> </div> <hr> <h2>HTML 注释</h2> <p>注释可以写在 <span class="marked"><!--</span> 和 <span class="marked">--></span> 中:</p> <div class="example"> <div class="example_code"> <span class="highCOM"><!-- 这是注释 --></span> </div> </div> <p>比较长的注释可以在 <span class="marked"><!--</span> 和 <span class="marked">--></span> 中分行写:</p> <div class="example"> <div class="example_code"> <span class="highCOM"><!-- <br>  这是一个较长注释。 这是 一个较长注释。这是一个较长注释。<br>  这是 一个较长注释 这是一个较长注释。 这是 一个较长注释。<br>--></span> </div> </div> <p>长注释第一个字符缩进两个空格,更易于阅读。</p> <hr> <h2>样式表</h2> <p>样式表使用简洁的语法格式 ( type 属性不是必须的):</p> <div class="example"> <div class="example_code"> <span class="highLT"><</span><span class="highELE">link</span> <span class="highATT">rel=</span><span class="highVAL">"stylesheet"</span> <span class="highATT">href=</span><span class="highVAL">"styles.css"</span><span class="highGT">></span> </div> </div> <p>短的规则可以写成一行:</p> <div class="example"> <div class="example_code"> <span class="highELE">p.into </span>{<span class="highATT">font-family:</span><span class="highVAL"> Verdana;</span> <span class="highATT">font-size:</span><span class="highVAL"> 16em;</span>}</div> </div> <p>长的规则可以写成多行:</p> <div class="example"> <div class="example_code"> <span class="highELE">body </span>{<br>  <span class="highATT">background-color:</span><span class="highVAL"> lightgrey;</span><br>  <span class="highATT">font-family:</span><span class="highVAL"> "Arial Black", Helvetica, sans-serif;</span><br>  <span class="highATT">font-size:</span><span class="highVAL"> 16em;</span><br>  <span class="highATT">color:</span><span class="highVAL"> black;</span><br>}</div> </div> <ul> <li>将左花括号与选择器放在同一行。</li> <li>左花括号与选择器间添加一个空格。</li> <li>使用两个空格来缩进。</li> <li>冒号与属性值之间添加一个空格。</li> <li>逗号和符号之后使用一个空格。</li> <li>每个属性与值结尾都要使用分号。</li> <li>只有属性值包含空格时才使用引号。</li> <li>右花括号放在新的一行。</li> <li>每行最多 80 个字符。</li> </ul> <table class="lamp"><tbody><tr> <th style="width:34px"> <img decoding="async" src="/images/lamp.jpg" alt="Note" style="height:32px;width:32px"></th> <td> 在逗号和冒号后添加空格是常用的一个规则。</td> </tr></tbody></table> <hr> <h2>在 HTML 中载入 JavaScript</h2> <p>使用简洁的语法来载入外部的脚本文件 ( type 属性不是必须的 ):</p> <div class="example"> <div class="example_code"> <span class="highLT"><</span><span class="highELE">script</span> <span class="highATT">src=</span><span class="highVAL">"myscript.js"</span><span class="highGT">></span> </div> </div> <hr> <h2>使用 JavaScript 访问 HTML 元素</h2> <p>一个糟糕的 HTML 格式可能会导致 JavaScript 执行错误。</p> <p>以下两个 JavaScript 语句会输出不同结果:</p> <div class="example"><h3>实例</h3> <div class="example_code"> <span class="highELE">var</span> obj = getElementById(<span class="highVAL">"Demo"</span>)<br><br><span class="highELE">var</span> obj = getElementById(<span class="highVAL">"demo"</span>) </div><br> <a class="tryitbtn" href="/try/try.php?filename=tryhtml_syntax_javascript" target="_blank" rel="noopener noreferrer">尝试一下 »</a> </div> <p>HTML 中 JavaScript 尽量使用相同的命名规则。</p> <p><a href="/js/js-conventions.html">访问 JavaScript 代码规范</a>。</p> <hr> <h2>使用小写文件名</h2> <p> 大多 Web 服务器 (Apache, Unix) 对大小写敏感: london.jpg 不能通过 London.jpg 访问。 </p><p> 其他 Web 服务器 (Microsoft, IIS) 对大小写不敏感: london.jpg 可以通过 London.jpg 或 london.jpg 访问。 </p><p> 你必须保持统一的风格,我们建议统一使用小写的文件名。</p> <hr> <h2>文件扩展名</h2> <p>HTML 文件后缀可以是 <strong>.html</strong> (或 <strong>.htm</strong>)。</p> <p>CSS 文件后缀是 <strong>.css</strong> 。</p> <p>JavaScript 文件后缀是 <strong>.js</strong> 。</p> <hr> <h2>.htm 和 .html 的区别</h2> <p> .htm 和 .html 的扩展名文件本质上是没有区别的。浏览器和 Web 服务器都会把它们当作 HTML 文件来处理。</p> <p>区别在于:</p> <p>.htm 应用在早期 DOS 系统,系统现在或者只能有三个字符。</p> <p>在 Unix 系统中后缀没有特别限制,一般用 .html。</p> <h2>技术上区别</h2> <p>如果一个 URL 没有指定文件名 (如 http://www.runoob.com/css/), 服务器会返回默认的文件名。通常默认文件名为 index.html, index.htm, default.html, 和 default.htm。</p> <p>如果服务器只配置了 "index.html" 作为默认文件,你必须将文件命名为 "index.html", 而不是 "index.htm"。</p> <p>但是,通常服务器可以设置多个默认文件,你可以根据需要设置默认文件名。</p> <p>不管怎样,HTML 完整的后缀是 ".html"。</p> <!-- 其他扩展 --> </div> </div> </div> <div class="cate_right"> <script src="https://www.520ads.com/Public/js/getGoods.js?site_id=9&size=300*300&sign=6f4922f45568161a8cdf4ad2299f6d23"></script> </div> </div> </div> <div class="clear"></div> <input type="hidden" id="uid" value=""> <div class="links w"> <h2 class="h_title"><span><a href="/" target="_blank">[ 申请 ]</a></span>友情链接:</h2> <div class="links_text"> <a href="https://jjj-com.com" target="_blank">传奇私服</a> <a href="https://www.xn--6kr41swoa.tw" target="_blank">南島屋</a> <a href="https://www.my103.com/ml/" target="_blank">My命理学</a> <a href="https://www.kuailian-app.com.cn" target="_blank">快连vpn</a> <a href="https://www.kuailian-go.com.cn" target="_blank">快连vpn</a> <a href="https://didi.seowhy.com" target="_blank">搜外友链</a> <a href="https://www.biquge.mobi" target="_blank">笔趣阁</a> <a href="https://aisi-zhushou.com" target="_blank">爱思助手</a> <a href="https://clashx.cc" target="_blank">ClashX教程</a> <a href="https://www.huihuabaobao.com" target="_blank">绘画宝宝</a> <a href="https://www.peiyinbaobao.com" target="_blank">配音宝宝</a> </div> </div> <footer> <div class="box"> <ul class="footer_nav"> <li><a href="" target="_blank">关于我们</a></li> <li><a href="" target="_blank">服务条款</a></li> <li><a href="" target="_blank">广告服务</a></li> <li><a href="" target="_blank">联系我们</a></li> <li><a href="" target="_blank">网站地图</a></li> <li><a href="" target="_blank">免责声明</a></li> <li><a href="" target="_blank">WAP</a></li> </ul> <p class="copyright">技术支持: <a href="/">武汉快勤科技有限公司</a> <a href="/">XML网站地图</a> 备案号:<a href="http://www.beian.miit.gov.cn/" target="_blank">鄂ICP备18027844号-9</a> <script type="text/javascript" src="//js.users.51.la/21769969.js"></script> </p> </div> </footer> <div class="modal"></div> <div class="login_box"> <div class="login_title"> 立即登录/注册 <img src="/Public/images/close.png" class="login_close"/> </div> <div class="login_content" id="login_scan"> <img src="/Public/images/ewm.png" class="ewm" id="ewm"> <p>微信扫码登录</p> </div> </div> <input type="hidden" id="wx_code" value=""> <div class="gotop"></div> <div class="ajax" id="ajax"></div> </body> </html> <script> function tips(text,reload=0){ $("#ajax").text(text).fadeIn(); setTimeout(function(){ $("#ajax").fadeOut(); if(reload){ location.reload(); } },2000); } function get_ewm(){ $.ajax({ url: '/home/login/get_wx_code.html', type: 'post', dataType:'json', success: function (res) { if(res.ret==1){ $("#wx_code").val(res.wx_code); ewm_login(); $.ajax({ url: 'https://www.qingketang.net/mobile/login_ewm.html', type: 'post', data:"code="+$("#wx_code").val(), dataType:'json', success: function (data) { $("#ewm").attr('src',data.ewm); } }); }else{ window.reload(); } } }); } function ewm_login(){ $(".modal").fadeIn(); $(".login_box").fadeIn(); $("#login_scan").show(); $("#loign_form").hide(); $("#reg_from").hide(); } function form_login(){ $(".modal").fadeIn(); $(".login_box").fadeIn(); $("#login_scan").hide(); $("#loign_form").show(); $("#reg_from").hide(); } function form_reg(){ $(".modal").fadeIn(); $(".login_box").fadeIn(); $("#login_scan").hide(); $("#loign_form").hide(); $("#reg_from").show(); } $(function(){ var win=$(window); //得到窗口对象 var sc=$(document);//得到document文档对象 win.scroll(function() { if (sc.scrollTop() > 700) { $(".gotop").fadeIn(); }else { $(".gotop").fadeOut(); } }); $(".gotop").click(function(){ $('html,body').animate({ scrollTop: 0 },600); }); $(".modal").click(function(){ $(".modal").fadeOut(); $(".login_box").fadeOut(); $("#wx_code").val(); }); $(".login_close").click(function(){ $(".modal").fadeOut(); $(".login_box").fadeOut(); $("#wx_code").val(''); }); $(".login_btn").click(function(){ get_ewm(); }); var c=setInterval(function(){ if($("#wx_code").val()!=''){ $.ajax({ url:'/home/login/ewm_login_ajax.html', type:'post', data:{"code":$("#wx_code").val()}, dataType:'json', success:function(data){ if(data.status==1){ $("#wx_code").val(''); $("#ajax").text(data.info).fadeIn(); setTimeout(function(){ $("#ajax").fadeOut(); location.reload(); },1000); clearInterval(c); } }, }); }else{ } },2000); }); </script> <script> async function copyTextToClipboard(text) { if (navigator.clipboard) { try { await navigator.clipboard.writeText(text); console.log('Text copied to clipboard'); } catch (err) { console.error('Failed to copy text: ', err); // 可以尝试使用 fallback 方案 fallbackCopyToClipboard(text); } } else { // 如果浏览器不支持 navigator.clipboard,则使用 fallback 方案 fallbackCopyToClipboard(text); } } $(function(){ $("pre").each(function(i,e){ console.log($(e).offset().top); var py=$(e).offset().top+10; var px=$(e).offset().left+$(e).width()-60; if($("#uid").val()){ var copybtn='点击复制'; }else{ var copybtn='登录复制'; } $(e).after("<span style='position:absolute;top:"+py+"px;left:"+px+"px;padding:0 8px;border-radius:3px;z-index:222222;cursor:pointer;background:#333;color:#fff;' class='copybtn'>"+copybtn+"</p>"); }); $(".copybtn").click(function(){ if($("#uid").val()){ var text=$(this).prev('pre').find("code").html(); copyTextToClipboard(text); $(this).text('已复制'); }else{ get_ewm(); } }); }); </script>