在指令碼標籤內使用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.