萬盛學電腦網

您现在的位置: 萬盛學電腦網 >> 程式設計 >  >> 網頁製作 >> HTML5 教學

HTML 註解完整用法指南:語法、巢狀限制、條件註解與最佳實踐

HTML 註解讓開發者在原始碼留下說明、暫時停用代碼、標記區塊邊界,且不會在瀏覽器畫面顯示。正確使用註解能提升代碼可讀性與團隊協作效率,但也有巢狀限制與舊版 IE 條件註解等特殊規則需注意。

基本語法

<!-- 這是單行註解 -->

<!--
  這是多行註解
  可以跨越多行
  結束標記不需在同一行
-->

<!-- <p>這段 HTML 暫時停用</p> -->

核心規則:

  • 以 `` 結束
  • 註解內容**不能包含 `--`**(兩個連字號),否則會提前結束或解析錯誤
  • 不可巢狀:` outer -->` 會在 `inner -->` 就結束
  • 不顯示於瀏覽器畫面,但可在「檢視原始碼」或開發者工具看到

CSS/JS 註解語法差異

語言單行註解多行註解可巢狀
HTML<!-- 註解 --><!-- 多行 -->否
CSS無/* 註解 */否(標準),支援 /* /* 巢狀 */ */(CSS 模組規範)
JavaScript// 註解/* 註解 */否

條件註解(IE 專用,已淘汰但仍需認識)

IE 5–9 支援的專屬機制,其他瀏覽器視為普通註解忽略:

<!--[if IE]>
  <link rel="stylesheet" href="ie-fix.css">
<![endif]-->

<!--[if lt IE 9]>
  <script src="html5shiv.js"></script>
<![endif]-->

<!--[if !IE]>>  <!-- 非 IE 瀏覽器才會解析 -->
  <link rel="stylesheet" href="modern.css">
<!--<![endif]-->

常見條件運算子:`IE` (所有 IE)、`lt` (小於)、`lte` (小於等於)、`gt` (大於)、`gte` (大於等於)、`!` (非)、`()` (分組)、`&` (且)、`|` (或)、`true`/`false` (常真/常假)。

⚠️ **IE10+ 已移除條件註解支援**,現代專案請改用特性偵測、Polyfill、漸進增強策略。

實務應用場景

1. 區塊邊界標記(大型模板必備)

<header class="site-header">
  <!-- BEGIN: Header -->
  ...
  <!-- END: Header -->
</header>

<main class="site-main">
  <!-- BEGIN: Main Content -->
  ...
  <!-- END: Main Content -->
</main>

2. 開發階段暫時停用功能

<!-- 
<section class="promo-banner">
  <h2>限時優惠</h2>
</section>
-->

3. 模板引擎區塊標記(非標準但常見慣例)

<!-- @section('content') -->
<!-- @endsection -->

<!-- {{-- Blade 註解:不會輸出到 HTML --}} -->

4. 建構工具標記(如 Webpack、Vite)

<!-- inject:css -->
<!-- endinject -->
<!-- vite:legacy -->
<!-- endvite -->

5. SEO 結構化資料調試

<script type="application/ld+json">
{
  "@context": "https://schema.org",
  "@type": "Article",
  "headline": "文章標題"
  <!-- "author": { "@type": "Person", "name": "作者" } -->
}
</script>

最佳實踐與禁忌

✅ 註解「為什麼」而非「做什麼」
`` 好過 ``
✅ 註解複雜邏輯、相依關係、暫時性妥協
``
✅ 大型區塊加上 BEGIN/END 標記
協助在幾千行模板中快速定位
❌ 註解掉大段代碼長期保留
請用版本控制(Git)管理,代碼庫不是垃圾桶
❌ 註解包含敏感資訊(密碼、API Key、內部網址)
前端原始碼公開可見,嚴禁洩露機密
❌ 註解內使用 `--` 連續連字號
會導致解析錯誤,改用 `==` 或 `~~` 分隔
❌ 巢狀註解
HTML 不支援,內層結束標記會關閉外層

建構工具自動移除註解(生產環境)

// vite.config.js
export default {
  build: {
    minify: 'terser',
    terserOptions: {
      compress: {
        drop_console: true,
        drop_debugger: true
      },
      format: {
        comments: false // 移除所有註解
      }
    }
  }
}

// 或使用 html-minifier-terser 專門處理 HTML
// npm install html-minifier-terser
const { minify } = require('html-minifier-terser');
const result = await minify(html, { removeComments: true, collapseWhitespace: true });

無障礙考量

  • 註解**不會**被螢幕閱讀器朗讀,可放心撰寫開發者專用說明
  • 若需對使用者隱藏但保留給螢幕閱讀器,請用 CSS `.visually-hidden` 而非註解
  • 條件註解內的內容不會被現代瀏覽器解析,不影響無障礙樹

善用 HTML 註解讓代碼自文件化,但切記:好代碼勝過好註解,清晰的命名與結構才是王道。定期清理過期註解,保持代碼庫整潔專業。

copyright © 萬盛學電腦網 all rights reserved