HTML 註解看似簡單,實際開發中常因巢狀、條件式註解、編碼問題踩坑。本文釐清標準語法、常見誤區,並對照 CSS、JavaScript 註解寫法,助你建立統一團隊規範。
<!-- 這是單行註解 -->
<!--
這是多行註解
可跨越多行
適合區塊說明或暫時停用代碼
-->
<!--(驚嘆號 + 兩連字號)-->(兩連字號 + 大於號)-- 序列,否則瀏覽器會在此提前結束註解,導致後續內容外洩顯示。<!-- 外層 <!-- 內層 --> 外層結束 --> 會在「內層結束」處就關閉,造成結構破壞。<!-- 錯誤:內含連字號序列 -->
<!-- 這是--錯誤的註解 -->
<!-- 錯誤:嘗試巢狀 -->
<!-- 外層開始
<!-- 內層 -->
外層結束 -->
<!--[if IE]>
<link rel="stylesheet" href="ie-fix.css">
<![endif]-->
現代專案請改用特性偵測或 Polyfill,勿依賴條件式註解。
/* 單行註解 */
/*
多行註解
適用於區塊說明、暫時停用樣式規則
*/
/* 外層 /* 內層 */ 外層 */ 會在第一個 */ 結束。// 單行註解(推薦大多數情況)
/*
多行註解
適合函式/類別文檔(JSDoc 格式)
*/
/**
* 函式說明
* @param {string} name - 參數說明
* @returns {boolean} 回傳值說明
*/
function greet(name) { ... }
| 語言 | 單行 | 多行 | 可巢狀 |
|---|---|---|---|
| HTML | <!-- 註解 --> | <!-- ... --> | 否 |
| CSS | /* 註解 */ | /* ... */ | 否 |
| JavaScript | // 註解 | /* ... */ | 否(但可用區塊註解包裹含單行註解的代碼) |
<!-- 區塊名 START --> / <!-- 區塊名 END -->` 成對標記,方便編輯器摺疊與搜尋。<!-- TODO: 優化圖片載入策略 -->` 便於工具掃描待辦事項。html-minifier-terser 等工具自動清除註解,減輕傳輸體積。統一註解規範,不僅提升代碼可讀性,更能降低團隊協作溝通成本,是專案品質管理的重要一環。