萬盛學電腦網

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

HTML 單行註釋迷思:為什麼沒有 // 或 #,正確寫法與團隊規範建議

核心結論

HTML 沒有單行註釋語法(如 //、#)。唯一合法註釋為 <!-- 內容 -->,單行、多行通用。

歷史與設計考量

  • HTML 早期設計為文檔標記語言,非程式語言,優先考量與文字內容共存。
  • 網頁大量包含 #(錨點、顏色代碼)、//(URL 協議、日期)等字元,若作為註釋符號將大量衝突,需大量轉義,反而增加複雜度。
  • <!-- --> 雖較長,但極低衝突機率,解析器易識別邊界。

正確單行註釋寫法

<!-- 單行註釋 -->
<div>內容</div> <!-- 行尾註釋 -->

常見錯誤示範

錯誤寫法結果修正
// 註釋顯示為純文字<!-- 註釋 -->
# 註釋顯示為純文字<!-- 註釋 -->
<! -- 註釋 -->解析錯誤(空格導致非標準)<!-- 註釋 -->
<!-- 註釋 -- -->提前閉合移除中間 --

編輯器效率技巧

  • VS Code:Ctrl+/ (Win) / Cmd+/ (Mac) 自動插入/切換 <!-- -->。
  • Emmet:輸入 c 按 Tab 展開為 <!-- -->。
  • 片段:自訂片段 hc → <!-- $1 -->。

團隊規範建議

  1. 統一使用 <!-- 內容 -->,禁止 //、#。
  2. 區塊標記採「開始/結束」成對:<!-- Header Start --> / <!-- Header End -->。
  3. TODO/FIXME 格式化:<!-- TODO(author): 描述 -->,利於工具掃描。
  4. CI 檢查:加入 htmlhint 規則 disallow-html-comments 限制生產建構保留註釋。
copyright © 萬盛學電腦網 all rights reserved