什麼是HTML評論以及如何使用它們
a當您在瀏覽器中查看網頁時,您會看到基於特定網頁的代碼顯示該軟件(網絡瀏覽器)顯示的內容。 如果您查看網頁的源代碼 ,您將看到由各種HTML元素組成的文檔,其中包括段落,標題,列表,鏈接,圖像等。 所有這些元素都由瀏覽器在訪問者的屏幕上呈現,作為網站顯示的一部分。 在HTML代碼中可以找到的一件事情,不是在人物屏幕上呈現的,就是所謂的“HTML註釋”。
什麼是評論?
評論是HTML,XML或CSS中不被瀏覽器或解析器查看或執行的代碼串。 它只是寫入代碼中以提供有關該代碼的信息或來自代碼開發人員的其他反饋。
大多數編程語言都有註釋,它們通常被代碼開發人員用於一個或多個,原因如下:
- 向將來可能需要處理的人描述並解釋複雜的代碼 - 包括他們自己! 他們可能會在12個月或更長時間後回到代碼3或6,並不記得他們為什麼以某種方式做了某些事情。 評論可以幫助回答他們的問題,並提醒他們當他們第一次開發該頁面時他們的頭腦在哪裡。
- 提供關於何時編輯或審查代碼的詳細信息。 這可能是有用的信息,有點像一個網站上次工作時的開發日誌。
- 刪除部分代碼,但將它們留出供以後使用。 這通常在現場測試和調試期間完成。 如果您在網站上遇到問題並且不確定是什麼導致了問題,那麼您可以逐個註釋第一部分,以確定問題,然後針對您遇到的任何問題解決問題。
- 與其他開發代碼的開發人員聊天。 這可能會在開發過程中完成,以便與同時處理代碼的其他人共享詳細信息。 如果這些評論純粹是開發性對話,那麼在網站推出之前將其從代碼中移除是最佳做法。
傳統上,HTML中的評論幾乎用於任何元素,從復雜表格結構的解釋到頁面本身內容的信息性評論。 由於評論不是在瀏覽器中呈現的,您可以將它們添加到HTML中的任何位置,並且不用擔心客戶查看網站時將執行的操作。
如何撰寫評論
用HTML,XHTML和XML編寫評論非常簡單。 簡單地將您想要註釋的文字置於以下位置:
<! -和
- >正如你所看到的,這些評論以“小於符號”開頭,加上一個感嘆號和兩個破折號。 評論以兩個破折號和一個“大於:符號結束。在這些角色之間,你可以寫任何你想要組成評論主體的東西。
在CSS中,它有點不同,使用C代碼註釋而不是HTML。首先使用正斜杠,後跟星號。 您可以用相反的方式結束評論,星號後跟正斜杠。
/ *評論文字* /評論是一個垂死的藝術
大多數程序員知道有用評論的價值。 評論代碼使代碼從一個團隊成員轉移到另一個團隊成員更容易。 評論可以幫助你的QA團隊測試代碼,因為他們可以告訴開發者的意圖 - 即使它沒有實現。 不幸的是,隨著Wordpress等網站創作平台的流行,它允許您啟動並運行一個選定的主題,為您處理HTML(如果不是全部)HTML,因此Web團隊不會經常使用評論。 這是因為如果您不直接使用代碼,那麼在大多數可視化創作工具中,評論真的很難看到。 例如,而不是在網頁的頂部看到:
<! - 不要編輯本頁,它是由腳本自動生成的 - >可視化工具顯示一個小圖標來表明有評論。 如果設計師沒有親自打開評論,他可能永遠都看不到它。 在上述頁面的情況下,如果她編輯頁面並且該評論中提到的腳本覆蓋了該編輯,則可能會導致問題。
可以做什麼?
- 寫出有意義且有用的評論。 不要指望其他人閱讀你的評論,如果他們太長或沒有包含有用的信息。
- 作為開發人員,您應該始終查看您在頁面上看到的任何評論。
- 使用允許您添加評論的創作程序提供的工具。
- 使用內容管理來控制頁面的編輯方式。
即使你是唯一編輯你的網頁的人,評論也是有用的。 如果您每年只編輯一個複雜頁面,很容易忘記您如何構建表格或將CSS放在一起。 有了評論,你不必記住,因為它是為你寫的。
Jennifer Krynin的原創文章。 在5/5/17由Jeremy Girard編輯