在 JavaScript 程式碼塊中使用 HTML 註釋是否有意義?


不,不建議使用 HTML 註釋來註釋程式碼塊。當 JavaScript 首次釋出時,一些瀏覽器不支援理解該指令碼。因此,當時需要一種技術來隱藏舊版瀏覽器的指令碼程式碼。因此,當時使用 JavaScript 塊中的 HTML 註釋來防止舊版瀏覽器在頁面上將指令碼程式碼顯示為文字。這種技術在 20 世紀 90 年代被採用。現在不再存在需要您在 JavaScript 中使用 HTML 註釋的瀏覽器。現在所有瀏覽器都理解 JavaScript 塊,因此在 JavaScript 程式碼塊中使用 HTML 註釋沒有意義。

我們為什麼要使用註釋?

註釋用於以有意義的方式顯示訊息。註釋用於解釋程式碼並提供有關警告、建議和程式碼的資訊,以便任何處理該程式碼的人員都能輕鬆理解技術流程。

什麼是 HTML 註釋?

在 HTML 檔案中,如果我們想要註釋任何程式碼,我們將使用以下語法:

語法

<!— your comment/ code here -->

如果瀏覽器不支援 JavaScript,則註釋的程式碼不會顯示或對終端使用者不可見。

在 JavaScript 程式碼塊中新增 HTML 註釋。

我們可以在指令碼塊中新增 HTML 以在不支援 JavaScript 的瀏覽器中隱藏指令碼程式碼。我們可以按照以下語法執行此操作。

語法

<script type="text/javascript">
<!--
   Some JavaScript code
//-->
</script>

我們應該在結束標籤之前新增 // -->

為什麼不建議使用 HTML 註釋?

現在,我們將瞭解為什麼不建議在 JavaScript 程式碼中使用 HTML 註釋。

在早期(1995 年),一些瀏覽器(如 Netscape 1)不支援指令碼標籤。因此,當 JavaScript 首次釋出時,需要從舊版瀏覽器中隱藏程式碼,以防止它們將其顯示為頁面上的文字。因此,在指令碼塊中使用 HTML 註釋來隱藏程式碼。

但現在,沒有瀏覽器不認識<script>標籤,因此無需隱藏 JavaScript 程式碼。無論如何,當我們使用 XHTML 文件時,這並不是一個好方法。在 XHTML 文件中,原始碼將被所有瀏覽器隱藏並變得無用,如果我們的程式碼中有任何遞減運算子,則 -- HTML 註釋無效。

示例 1

讓我們以使用 HTML 註釋在程式碼中註釋 JavaScript 程式碼塊的示例為例。

<html> <title>Online JavaScript Editor</title> <head> </head> <body> <h2>Checking comments in JavaScript code</h2> <script> <!-- var a = 10; var b = 20; document.write(a+b); //--> </script> </body> </html>

請注意,我們甚至註釋了程式碼塊以在執行時跳過程式碼,但引擎並未忽略它。因為我們使用了 HTML 註釋。如果我們的瀏覽器不支援 JavaScript,則指令碼程式碼將被視為註釋。

示例 2

我們可以使用多行註釋來跳過該程式碼,而不是 HTML 註釋。例如,

<html> <title>Online JavaScript Editor</title> <head> </head> <body> <h2>Checking comments in JavaScript code</h2> <script> /* var a = 10; var b = 20; document.write(a+b); */ </script> </body> </html>

請注意,引擎忽略了程式碼。

如果要編寫多行 JavaScript 程式碼並希望使用註釋來解釋程式碼。建議使用外部 JavaScript 檔案,並在 HTML 程式碼中的指令碼標籤中匯入這些檔案。

更新於: 2022 年 8 月 26 日

99 次瀏覽

開啟您的職業生涯

透過完成課程獲得認證

開始學習
廣告

© . All rights reserved.