為什麼要寫 HTML 註解?
- 幫助團隊成員快速理解代碼結構與意圖。
- 方便日後維護、除錯與重構。
- 標記暫時移除的代碼區塊,避免誤刪。
- 記錄頁面模組對應的功能或需求編號。
基本語法
<!-- 註解內容 -->
註解內容不會輸出到前端頁面,僅在源碼可見。
實際範例
<!-- 頁首導航區塊開始 -->
<header>...</header>
<!-- 頁首導航區塊結束 -->
注意事項
- 註解不可巢狀(即註解內不可再包含
<!-- -->)。
- 避免在註解中放置敏感資訊(如 API 金鑰、內部路徑)。
- 條件註解(IE 專用)已棄用,現代專案不建議使用。
養成良好的註解習慣,是專業前端工程師的基本素養。