在 HTML 中評論 Javascript

| | | | | | | | | | | | | | | | | | | | | |

要寫 HTML 註釋插入 <--- ! - - -> 在註釋的兩端。眾所周知,HTML 註釋可以使 HTML 代碼保持井井有條,並且會被瀏覽器忽略。

文檔軟件最重要的方面之一是對代碼的書面註釋。註釋是存在於計算機程序中的行,解釋器和編譯器會忽略這些行,旨在供人類閱讀。

編寫註釋可以讓您的代碼更具可讀性,並指示特定部分的內容製作的程序。例如,如果您正在編寫一個長程序,您可以使用註釋來跟踪某些函數或代碼行。

在本教程中,我們將探討如何在 HTML 中編寫註釋。我們將從查看為什麼在編程中使用註釋開始。接下來,我們將看看兩種主要類型的評論:。單行註釋和多行註釋

為什麼開發人員要寫註釋

在 HTML 中,註釋被忽略了?由瀏覽器和它們在代碼被編譯和縮小時被刪除。那麼我們為什麼要寫評論呢?

寫評論是為了讓人們閱讀並幫助使代碼更容易理解。當您處理單個項目時,很容易跳過註釋,因為您是唯一閱讀代碼的人。但是,如果您正在處理包含複雜代碼的大型項目,您很容易忽略代碼的用途。

此外,如果您在團隊中工作,其他人可能無法理解代碼你寫了。如果出現這種情況,人們可能不得不跟著你找出特定代碼的用途,或者他們可能會跳過一行代碼而不理解它的含義和工作原理。

註釋為開發人員提供了許多好處。首先,正如我們所討論的,註釋使您的代碼更易於理解。如果您在代碼上寫註釋,您和其他閱讀過代碼的人會發現更容易跟踪代碼中某些點發生的情況

div>

其次,註釋允許開發人員解釋他們對程序的決策背後的原因。這對於程序停止運行並需要修復錯誤的時候很有用,或者當開發人員需要更清楚地了解原因時使用特定的方法來解決問題。註釋還可以幫助加快開發過程,因為它更容易讓您理解您的代碼。

HTML 註釋

HTML 中的註釋文檔被特殊的箭頭包圍,並與程序的其餘部分分開。瀏覽器不顯示註釋。這是基本 HTML 註釋標記的語法:

當我們的網頁打開時,這段代碼不會不會出現在我們的網頁上。取而代之的是,代碼會出現在我們的源代碼中以供閱讀。

上面的例子是單行註釋,這意味著文本只會出現在一行上。如果您的評論很短,這種類型的評論很有用。但是,如果您打算寫長註釋,則應使用多行註釋。

多行註釋的語法與單行註釋相同,唯一的區別是註釋在一條新的農場線上。下面是多行註釋標籤的語法:

使用 HTML 註釋

既然您知道如何編寫 HTML 註釋,您可能想知道:什麼時候應該在我的代碼中添加註釋?雖然沒有關於何時使用反饋的嚴格準則,並且每個開發人員和團隊都有自己的偏好,但您應該記住一些事項。

一般應該使用註釋:

當然,還有其他情況可以在代碼中添加註釋,但這些是最常見的。

另外,你也可以使用HTML 註釋用於對 HTML 標記塊進行註釋。這允許您在程序中保留一行代碼,但會告訴瀏覽器在呈現 HTML 網頁時忽略它。

在程序外部註釋代碼在調試時很常見,因為在調試時,您需要找到問題的原因並實施解決方案,並且告訴程序忽略代碼而不將其從程序中完全刪除會很有幫助。這是一個示例使用 HTML 註釋來註釋代碼:

是一個示例段落。

這是另一個例子,段落。

--->

當我們的瀏覽器呈現這段代碼時,第二個段落被忽略,因為它包含在註釋中。

HTML 註釋雖然有用,但只能在它們為程序增加價值時使用。無需添加註釋來解釋程序的所有功能或以有意義的方式解釋參數。以下是編寫 HTML 註釋時應牢記的一些提示:

結論

使用註釋 HTML 有助於提醒您prog 對於您和其他閱讀您的代碼的人來說更具可讀性。在您的代碼中編寫註釋可以讓其他人更容易理解您的代碼背後的意圖。

在本教程中,我們探討了評論的基礎知識以及如何在 HTML 中創建評論。我們還討論了為什麼評論很有用,我們探索了有效編寫評論的最佳實踐。也就是說,每個開發人員都有自己的評論風格,當您編寫其他評論時,您會發現

現在您知道如何像專家一樣編寫 HTML 註釋了!