標準多行註釋語法
<!--
這是多行註釋
可以寫任意行數
直到遇到閉合標記 -->
關鍵規則
- 起始:
<!--,結束:-->。
- 單行、多行語法完全相同,只差內容行數。
- 不可巢狀:內層
--> 會提前閉合外層。
- 內容不可含
--(除邊界標記外)。
實務範例
<!--
@module Header
@description 全站共用頁首,包含 Logo、主導航、語言切換
@author frontend-team
@last-modified 2024-01-15
-->
<header class="site-header">
<div class="container">
<a href="/" class="logo" aria-label="回首頁"><svg>...</svg></a>
<nav class="main-nav" aria-label="主要導航">
<ul>
<li><a href="/products">產品</a></li>
<li><a href="/pricing">方案</a></li>
<li><a href="/about">關於我們</a></li>
</ul>
</nav>
</div>
</header>
常見錯誤與除錯
| 現象 | 原因 | 修正 |
| 頁面大段內容消失 | 註釋未正確閉合,吞噬後續內容 | 檢查是否漏寫 --> 或誤含 -- |
| 註釋內容顯示在頁面 | 巢狀註釋導致提前閉合 | 移除內層註釋或改用版本控制暫存 |
| 瀏覽器報錯「Unexpected token」 | 註釋置於 <script>/<style> 內部 | JS 用 //、CSS 用 /* */ |
自動化品質管控
// .htmlhintrc
{
"rules": {
"disallow-html-comments": true, // 生產建構禁止殘留註釋
"attr-value-double-quotes": true,
"tagname-lowercase": true
}
}
// package.json scripts
"lint:html": "htmlhint \"src/**/*.html\"",
"build": "npm run lint:html && vite build"