寫 HTML 時,我們常會在關鍵位置補上一句說明。這個習慣的好處很實際:自己回頭看時能快速定位思路,同事接手時能立刻明白你的意圖,專案規模變大之後,它更是維持可讀性的基本配備。
語法:
<!--注釋的內容-->
說明:
「<!--」代表注釋開始,「-->」代表注釋結束。
舉例:
<!DOCTYPE html> <html xmlns="https://www.w3.org/1999/xhtml"> <head> <title></title> </head> <body> <h6>靜夜思</h6> <!--標題標籤--> <p>床前明月光,疑是地上霜。</p> <!--文本標籤--> <p>舉頭望明月,低頭思故鄉。</p> <!--文本標籤--> </body> </html>
把這段代碼貼進 Visual Studio,你會發現注釋的顏色和其他代碼明顯不同——它會顯示為淺綠色,一眼就能辨認。
而在瀏覽器中預覽時:
說明:
如圖所示,被 <!----> 包住的內容完全不會出現在頁面上。這正是注釋的設計目的:它是寫給「讀代碼的人」看的,而不是寫給「看網頁的人」看的。對關鍵邏輯留下說明,等於替你未來的自己留下一條線索。
養成寫注釋的習慣尤其重要。在真實的網站或功能模組開發中,單一檔案動輒數百上千行,若關鍵段落沒有任何標記,往往連作者自己都會看得頭暈,甚至搞不清當初為什麼這樣寫。這份體會,等你真正參與專案就會深刻感受到。
除了通用寫法,Visual Studio 還提供了一種專屬語法。
語法:
<%--注釋的內容--%>
說明:
「<%--」標誌開始,「--%>」標誌結束。
舉例:
<!DOCTYPE html> <html xmlns="https://www.w3.org/1999/xhtml"> <head> <title></title> </head> <body> <h6>靜夜思</h6> <%--標題標籤--%> <p>床前明月光,疑是地上霜。</p> <%--文本標籤--%> <p>舉頭望明月,低頭思故鄉。</p> <%--文本標籤--%> </body> </html>
同樣貼進 Visual Studio,效果如下:
預覽結果與通用注釋一致,注釋內容不會顯示。
最後提醒一個關鍵差異:「<!--注釋內容-->」是標準寫法,在任何網頁編輯器中都能正常使用;而「<%--注釋內容--%>」只在 Visual Studio 環境下有效。寫給所有人看的代碼,優先選擇通用語法。