萬盛學電腦網

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

HTML 註釋寫法與最佳實踐:條件註釋、工具整合與團隊規範

HTML 註釋(`<!-- ... -->`)不會在瀏覽器顯示,是開發者溝通、標記待辦、暫時禁用代碼的重要工具。本文說明正確寫法、進階用法與團隊規範建議。

基本語法

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

<!--
  這是多行註釋
  可以跨越多行
  結束標記不必與開始標記同行
-->

關鍵規則

  • 以 <!-- 開頭,**感嘆號後接兩個連字號**
  • 以 --> 結束,**大於號前有兩個連字號**
  • 註釋內**不能包含雙連字號序列**(`--`),否則會提前結束或導致解析錯誤
  • 註釋不可巢狀

常見用途

用途範例
區塊標記<!-- Header Start --> ... <!-- Header End -->
待辦事項<!-- TODO: 優化圖片載入 -->
暫時禁用代碼<!-- <div class="ad">...</div> -->
模板標記<!-- @include('partials/nav') -->(伺服器端模板引擎)
建構工具指令<!-- build:css css/main.min.css --> ... <!-- endbuild -->(usemin/grunt/gulp)

IE 條件註釋(歷史參考)

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

<!--[if gt IE 9]><!-->
  <link rel="stylesheet" href="modern.css">
<!--<![endif]-->

IE10+ 已移除支援,現代專案不再需要,改用特性偵測或 Polyfill。

團隊規範建議

  • 統一註釋風格:區塊標記用大寫開頭、TODO 用大寫、作者/日期可選
  • 建構流程中**移除註釋**(HTMLMinifier、Vite、Webpack html-minifier-terser),減少傳輸體積
  • 開發環境保留,生產環境移除
  • 敏感資訊(API Key、內部路徑、待修復漏洞)**嚴禁**寫在註釋中
  • 使用編輯器 Snippet 快速插入標準註釋區塊

編輯器支援

  • VS Code:Ctrl+/ 切換行註釋、Shift+Alt+A 區塊註釋
  • Emmet:輸入 c 按 Tab 展開 <!-- -->
copyright © 萬盛學電腦網 all rights reserved