使用 HTML 進(jìn)行編碼時(shí),編寫注釋是一種很好的做法。那么,如何在 HTML 中添加注釋呢?在編寫軟件文檔時(shí),在代碼中添加注釋至關(guān)重要。評(píng)論在網(wǎng)頁(yè)上不可見,因?yàn)樗鼈儾皇轻槍?duì)讀者的。
瀏覽器會(huì)忽略評(píng)論標(biāo)簽之間的任何文本,因此不會(huì)顯示在網(wǎng)絡(luò)上。用于注釋的 HTML 用于解釋代碼。編寫代碼注釋的目的是使代碼具有可讀性,并根據(jù)不同部分的作用來(lái)解釋代碼。用戶經(jīng)常使用注釋來(lái)監(jiān)控代碼行。當(dāng)開發(fā)人員社區(qū)致力于單個(gè)項(xiàng)目時(shí),HTML 注釋會(huì)派上用場(chǎng)。它們的作用主要是促進(jìn)交流。
HTML 注釋的類型
HTML注釋?有四種類型。
1. 單行注釋?
用戶可以對(duì)單行進(jìn)行評(píng)論。請(qǐng)注意,單行注釋以特殊箭頭 <!--- 注釋---> 開頭。然后編譯器會(huì)忽略正斜杠和行尾之間的內(nèi)容。
在代碼行之前使用單行注釋的示例如下:
<! --- code comment---> < Users can comment on single lines>?
以下是在代碼行末尾使用的注釋示例:
< Users can comment on single lines><! --- code comment--->.?
2.多行注釋?
用戶還可以在多行上使用 HTML 注釋代碼。盡管如此,評(píng)論仍然沒(méi)有顯示。只有代碼行將在輸出中。
3. HTML 注釋標(biāo)簽??
您可以使用 <comment> 向代碼添加注釋。但是,請(qǐng)注意,這通常可以通過(guò) Internet Explorer 實(shí)現(xiàn)。
4. 有條件的評(píng)論??
這些注釋用于執(zhí)行具有設(shè)定條件的特定代碼。Internet Explorer 支持像 <comment> 標(biāo)簽這樣的條件注釋。
評(píng)論的使用
雖然沒(méi)有具體的評(píng)論使用指南,但不同的開發(fā)者有自己的偏好。本質(zhì)上,注釋用于:
- 解釋編寫代碼的原因。
- 突出顯示代碼的結(jié)果。
- 使代碼行更清晰。
用戶還應(yīng)注意,評(píng)論的使用不僅限于上述三種情況。有更多的方法可以使用它們。
通常,程序員在調(diào)試期間使用注釋。他們使用注釋來(lái)請(qǐng)求瀏覽器忽略代碼而不必消除它,因?yàn)樗麄冊(cè)\斷問(wèn)題的原因并嘗試排除故障。
僅當(dāng)它們?yōu)槌绦騽?chuàng)造價(jià)值時(shí)才使用 HTML 注釋。開發(fā)人員不需要解釋程序中代碼的每一個(gè)功能。他們還應(yīng)該了解向 HTML 添加注釋的最佳實(shí)踐,例如不向明顯的事物添加注釋。請(qǐng)注意,過(guò)度使用注釋可能會(huì)分散主代碼的注意力。
用戶也不應(yīng)重述現(xiàn)有代碼。請(qǐng)記住,注釋用于闡明代碼中的邏輯。不要用它們來(lái)說(shuō)明已經(jīng)寫在代碼行中的內(nèi)容。如果可能,開發(fā)人員需要避免長(zhǎng)注釋。如果他們覺(jué)得需要很長(zhǎng)的評(píng)論來(lái)解釋復(fù)雜的功能,他們可以選擇文檔條目。
雖然評(píng)論不會(huì)在網(wǎng)站上呈現(xiàn),但如果您將文檔公開,任何人仍然可以在互聯(lián)網(wǎng)上訪問(wèn)它們。他們可以幫助您跟蹤和監(jiān)控代碼,即使在幾個(gè)月沒(méi)有工作的情況下也是如此。他們還支持與其他開發(fā)人員的溝通。
注釋有兩個(gè)主要好處,使您的代碼易于理解并跟蹤代碼的不同部分。
盡可能避免使用 HTML 注釋的原因
開發(fā)人員使用 HTML 注釋來(lái)增加代碼的可讀性、調(diào)試、幫助其他人揭開他們的代碼的神秘面紗以及標(biāo)記結(jié)束標(biāo)記。除了上述原因之外,這就是您應(yīng)該避免使用 HTML 注釋的原因。
1.會(huì)影響用戶體驗(yàn)?
您可能想知道 HTML 評(píng)論如何影響性能,但評(píng)論并未呈現(xiàn)在網(wǎng)站上。
請(qǐng)注意,注釋仍然是文檔對(duì)象模型 (DOM) 的一部分。這會(huì)增加 DOM 元素,從而影響網(wǎng)頁(yè)的響應(yīng)性。它還會(huì)影響速度,表現(xiàn)為對(duì) DOM 和 CSS 選擇器的緩慢操作。
2.它會(huì)傷害你的SEO?
過(guò)多的 HTML 評(píng)論會(huì)影響您的 SEO,但不會(huì)影響關(guān)鍵字或內(nèi)容排名。評(píng)論被瀏覽器忽略并且不計(jì)入排名。但是,它們會(huì)影響您的頁(yè)面加載速度。
評(píng)論過(guò)多會(huì)增加文檔和網(wǎng)頁(yè)的大小(以字節(jié)為單位)。這將影響頁(yè)面加載時(shí)間,對(duì)您的排名產(chǎn)生負(fù)面影響。請(qǐng)注意,如果加載時(shí)間超過(guò) 3 秒,用戶將在點(diǎn)擊后退出頁(yè)面,導(dǎo)致跳出率較高。高跳出率對(duì)網(wǎng)站來(lái)說(shuō)是一個(gè)負(fù)面信號(hào),因?yàn)樗l(fā)送的信息是該頁(yè)面對(duì)訪問(wèn)者沒(méi)有幫助。
太多的評(píng)論也會(huì)損害文本與 HTML 的比例。應(yīng)保持 25% 到 70% 之間的良好文本與 HTML 比率。該比率表示可見內(nèi)容的百分比。請(qǐng)注意,搜索引擎會(huì)為具有大量可見內(nèi)容的網(wǎng)站提供高排名。
3.帶寬損失?
大型 HTML5 評(píng)論內(nèi)容會(huì)導(dǎo)致帶寬使用量激增。擁有更多字節(jié)會(huì)導(dǎo)致流量顯著增加。
結(jié)論
如果以正確的方式和數(shù)量使用 HTML 注釋,則對(duì)開發(fā)人員很有用。通過(guò)使用它們,您可以使您的代碼更易于理解。那是給任何可以打開你的源代碼的人。
如果您正在與其他開發(fā)人員團(tuán)隊(duì)一起開發(fā)一個(gè)項(xiàng)目,這些評(píng)論可以幫助您保持在同一頁(yè)面上并使協(xié)作變得容易。上面的信息為您提供了有關(guān)如何在 HTML 中添加注釋的指導(dǎo)性基礎(chǔ)知識(shí),包括它們是什么、如何使用它們、何時(shí)使用它們、開發(fā)人員為什么使用它們以及何時(shí)應(yīng)該避免它們。