萬盛學電腦網

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

HTML 註解語法完整指南:標準寫法、條件註解、最佳實踐與常見錯誤

標準 HTML 註解語法

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

<!--
  這是多行註解
  可以跨越多行
  瀏覽器會完全忽略這裡的內容
-->
  • **開始標記**:<!--
  • **結束標記**:-->
  • **內容**:除 -- (兩個連字號) 外可包含任意字元。**註解內不能出現連續兩個連字號**,否則會提前結束或導致解析錯誤。
  • **不可巢狀**:<!-- 外層 <!-- 內層 --> 外層 --> 會在內層結束標記處結束,外層剩餘內容會被當作文字顯示。

條件註解 (Conditional Comments) - 僅 IE 5-9 支援

**現代瀏覽器 (IE10+, Edge, Chrome, Firefox, Safari) 忽略條件註解,視為普通註解。** 僅用於維護極舊版 IE 專案。

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

<!--[if gt IE 8]><!--> <!-- 非 IE 或 IE>8 可見 -->
  <link rel="stylesheet" href="modern.css">
<!--<![endif]-->

<!--[if !IE]>> <!-- 非 IE 可見 (IE 視為註解) -->
  <script src="modern.js"></script>
<!--<![endif]-->

語法:<!--[if 條件]> HTML 內容 <![endif]-->。條件關鍵字:IE, lt (小於), lte (小於等於), gt (大於), gte (大於等於), ! (非), & (且), | (或), () (分組)。

其他語言的註解語法 (易混淆)

語言/情境單行註解多行註解備註
HTML無<!-- 註解 -->唯一標準語法
CSS無/* 註解 */可巢狀 (CSS 原生不支援,但預處理器 Sass/Less 支援)
JavaScript// 註解/* 註解 */JSX/TSX 同 JS
TypeScript///* */支援 JSDoc /** */
PHP//, #/* */HTML 中 PHP 區塊用 PHP 註解
Python#""" 多行字串常用作註解 """無原生多行註解
SQL--/* */
Shell/Bash#: ' 多行註解 ' (技巧)
VBScript / ASP' 註解無舊版 ASP 伺服器端腳本
JSON**不支援註解****不支援**嚴格禁止,JSONC/JSON5 支援

最佳實踐與規範

  1. 解釋「為什麼」,而非「做什麼」:
    <!-- 差:設定容器寬度 -->
    <div style="width: 960px;">
    
    <!-- 好:配合 960px 格線系統,確保主流螢幕無捲軸 -->
    <div class="container">
  2. 標記區塊邊界 (大型檔案):
    <!-- ===== Header 區塊 開始 ===== -->
    <header>...</header>
    <!-- ===== Header 區塊 結束 ===== -->
  3. 標記待辦/已知問題:
    <!-- TODO: 待替換為 API 動態資料 -->
    <!-- FIXME: IE11 flexbox bug 暫時用 float 方案 -->
    <!-- HACK: 修正 Safari flex 最小寬度 bug -->
  4. 條件式載入資源** (現代替代方案):
    <!-- 現代做法:JS 特性偵測 / 動態 import / CSS @supports -->
    <script>
      if (!('IntersectionObserver' in window)) {
        import('./polyfill-intersection-observer.js');
      }
    </script>
  5. 不要註解掉大量程式碼** 留存:使用版本控制 (Git) 管理歷史版本。註解掉的程式碼會腐爛、誤導、增加檔案體積。
  6. 建置流程移除註解:生產環境部署前,使用 HTMLMinifier、Vite、Webpack 等工具移除註解 (保留授權聲明 <!--! ... --> 或 /*! ... */)。

常見錯誤與除錯

錯誤寫法問題正確寫法
<!-- --> (空註解)合法但無意義移除或加入說明
<!-- -- -->內含 -- 導致解析錯誤<!-- 避免連續連字號 -->
<!-- <div> --> -->巢狀註解,外層提前結束拆分為兩個獨立註解
<!--[if IE]>...<![endif]-->用於非 IE 環境移除,改用特性偵測
註解包含敏感資訊 (API Key, 內部路徑)前端原始碼公開可見**絕對禁止**,建置流程檢查
在 <title>, <style>, <script> 內使用 HTML 註解內容被當作文字/腳本一部分,不生效CSS 用 /* */,JS 用 ////* */

開發者工具查看註解

  1. Chrome DevTools → **Elements** 面板 → DOM 樹中可見灰色註解節點。
  2. **Sources** 面板 → 開啟 HTML 檔案 → 註解顯示為灰色斜體。
  3. Ctrl/Cmd+Shift+P → 輸入 "Show Console" → Console 面板輸入 document.querySelectorAll('*') 檢查節點。

結語

HTML 註解雖簡單,但**正確語法、良好習慣、區分語言差異、避免敏感資訊洩漏、建置移除**是專業開發者的基本素養。條件註解已成歷史,現代專案請改用特性偵測、漸進增強、建置時注入環境變數等標準方案。

copyright © 萬盛學電腦網 all rights reserved