在指令碼標籤內使用 HTML 註釋是否最佳實踐?


在嘗試理解HTML 註釋指令碼標籤內是否為最佳實踐之前,讓我們討論一下如何在 HTML 中編寫註釋,以及在 HTML 中註釋的不同方法。

通常,註釋有助於理解語句,留下備註並提供解釋。它還有助於在測試或開發新功能時停用語句。

語法

以下是註釋表示的語法:

<!--  statement-->

讓我們看看在程式中表示註釋的不同方法:

插入單行註釋

單行註釋應用於單個語句,使用開始標籤和結束標籤,例如 <!-- -- >。我們將插入這些註釋以提醒程式碼中正在發生的事情。

注意 - 註釋標籤中不應有空格,例如 < ! – 無效。在標籤內可以包含任意數量的空格,但標籤必須在沒有空格的情況下表示 <!--

示例

以下示例顯示瞭如何表示單行註釋:

<html>
<head>
   <title> Single line comment</title>
</head>
<body>
   <!—paragraph begins here -->
   <p> TutorialsPoint Website</p>
</body>
<html>

當我們執行以上程式碼時,將顯示單行註釋“Tutorialspoint 網站”。

如何建立多行註釋

可以使用多行註釋跨越多行,這有助於解釋複雜的程式碼。

示例

以下是示例,它顯示瞭如何在 HTML 中表示多行註釋。

<html>
<head>
   <title> Multiline comments</title>
</head>
<body>
   <!—
      TutorialsPoint is having a technical content website Where we can find all technical related information with Content as well as videos 
   -->
   <p> TutorialsPoint WEBSITE </p>
</body>
<html>

當我們執行以上程式碼時,輸出將以多行註釋顯示。

如何使用註釋功能快速停用程式碼

當我們試圖跟蹤錯誤或試圖阻止程式碼在頁面上執行時,我們可以使用註釋功能快速阻止程式碼,這樣我們就可以透過簡單地刪除註釋標籤輕鬆地恢復程式碼。

示例

以下示例顯示瞭如何在 HTML 中使用註釋功能快速停用程式碼。

<html>
<head>
   <title>Comment function for quickly disable code</title>
</head>
<body>
   <p>Images related to Courses</p>
   <img src="https://tutorialspoint.tw/images/ncert-books-class-6-maths_icon.svg" height=150 width=150><br><br>

   <!-- Hiding this image for now
   <img src="/images/pic2.jpg height=150 width=150"><br>
   -->
   <img src="https://tutorialspoint.tw/images/statistics_icon.svg" height=150 width=150>

</body>
</html> 

當我們執行以上程式時,將顯示與課程相關的文字以及影像。

註釋功能以隱藏不受支援的瀏覽器上的指令碼

如果我們使用JavaScript或任何其他指令碼語言,我們使用註釋功能隱藏不支援該瀏覽器的瀏覽器上的指令碼。為了確保指令碼在支援的瀏覽器上工作,我們必須在指令碼的開頭插入註釋,並在 //--> 處結束它。

示例

以下示例顯示瞭如何使用註釋功能隱藏不受支援的瀏覽器上的指令碼。

<html>
<head>
   <title>JavaScript</title>
</head>
<body>
   <script language="javascript" type="text/javascript">
      <!--
         document.write("Hello World!")
      //-->
   </script>
</body>
</html>

示例

考慮一個示例,它解釋了在 HTML 中編寫註釋是否為最佳實踐。

JavaScript 可以使用放置在 <script>... </script> 內的JavaScript 語句來實現。

</script>.
   <script ...>
   JavaScript code
</script>

示例

HTML 註釋新增到 <script> 標籤中,這是可選的:

<html>
<body>
   <script>
      <!--
         document.write("Hello World!")
      //-->
   </script>
</body>
</html>

更新於:2023 年 11 月 9 日

1K+ 次檢視

開啟您的 職業生涯

透過完成課程獲得認證

開始學習
廣告

© . All rights reserved.