HTML 註釋有固定格式,且與 CSS、JavaScript 註釋語法不同。本文清楚說明 HTML 註釋正確寫法、常見錯誤,並提供跨語言註釋對照表,避免混淆。
<!-- 這裡是註釋內容 -->
<!-- (四字元:小於號、驚嘆號、兩個連字號)--> (兩個連字號、大於號)--** (開頭結尾除外),否則會導致解析錯誤或提前結束。<!-- 單行註釋 -->
<!--
多行註釋範例
說明這一段的功能
作者: Zhang San
日期: 2024-01-15
-->
<div class="card">
<!-- 產品卡片開始 -->
<img src="product.jpg" alt="產品圖片">
<h3>產品名稱</h3>
<!-- 產品卡片結束 -->
</div>
<!-- TODO: 這裡後續要加入價格顯示邏輯 -->
<!-- 錯誤:內容含有 -- 連字號 -->
<!-- 這是--錯誤的註釋 -->
<!-- 錯誤:巢狀註釋 -->
<!-- 外層 <!-- 內層 --> 外層 -->
<!-- 錯誤:未正確閉合 -->
<!-- 缺少結尾
| 語言/環境 | 單行註釋 | 多行/區塊註釋 | 備註 |
|---|---|---|---|
| HTML | <!-- 註釋 --> | <!-- 多行 | 不可巢狀,禁連續 -- |
| CSS | 無單行語法 | /* 註釋 */ | 標準 CSS 不支援巢狀;Sass/Less/PostCSS 支援巢狀 |
| JavaScript | // 註釋 | /* 註釋 */ | 標準 JS 不支援巢狀;TypeScript/JSDoc 有文檔註釋 /** */ |
| TypeScript | // | /* */ | JSDoc: /** @param {string} name */ |
| JSX (React) | {// 註釋} | {/* 註釋 */} | JSX 中 HTML 註釋需寫 {'<!-- -->'} |
| Vue (SFC) | <!-- 輸出到 DOM --> | <!-- 輸出到 DOM --> | 模板區塊用 HTML 註釋;`
HTML5 教學排行推薦文章
copyright © 萬盛學電腦網 all rights reserved
|