使用 HTML 註釋 <!-- … -->
HTML 註釋用於在標記中新增說明性註釋,或阻止瀏覽器解釋文件的特定部分。
註釋以字串 <!-- 開始,以字串 --> 結束,中間通常包含文字。此文字不能以字串 > 或 -> 開頭,不能包含字串 --> 或 --!>,也不能以字串 <!- 結尾,但允許 <!。
瀏覽器在渲染程式碼時會忽略註釋。換句話說,它們在頁面上不可見——只在程式碼中可見。HTML 註釋是您為程式碼或邏輯編寫有用說明的一種方式。
上述說法同樣適用於 XML 註釋。此外,在 XML 中,例如在 SVG 或 MathML 標記中,註釋不能包含字元序列 --。
註釋可以單行使用,也可以跨越多行使用。它們可以在以下位置使用
- 在 Doctype 之前和之後
- 在
<html>元素之前和之後 - 作為大多數元素的(塊級)內容,但以下元素除外:
<script>、<style>、<title>、<textarea>,因為這些元素將其內容解釋為純文字
注意:雖然 <script> 元素不應包含 HTML 註釋,而應使用 JavaScript 註釋,但過去有一種將整個指令碼內容包含在 HTML 註釋中的做法,以便不支援 JavaScript 的舊式瀏覽器不會將其渲染為文字。這現在是 JavaScript 本身的一項遺留功能,您不應依賴它。
語法
html
<!-- Comment -->
示例
html
<!-- A one-line comment -->
<!--
A comment
that stretches
over several
lines
-->
<!-- The comment below disables
the HTML contained within -->
<!--
<p>
This content will not be rendered.
</p>
-->
注意
HTML 註釋僅允許作為內容。您不能在標籤內使用它,例如在 HTML 屬性之前。
與大多數使用 <!-- --> 註釋語法的程式語言一樣,註釋不能巢狀。換句話說,緊跟在 <!-- 之後的第一個 --> 會關閉註釋。
雖然註釋以 < 開始,以 > 結束,但註釋不是 HTML 元素。
規範
| 規範 |
|---|
| HTML # 註釋 |
另見
- JavaScript 中的註釋
- CSS 中的註釋
CommentAPI (Comment繼承自Node)