DIV CSS 佈局教程網

您现在的位置: DIV+CSS佈局教程網 >> 網頁腳本 >  >> HTML基礎知識 >> HTML和Xhtml
別小看 HTML 註解:從程式可讀性到樣板注入的深層用途
編輯:HTML和Xhtml     

查看大型網站的原始碼,會發現滿滿的註解。以新浪網為例,註解標籤被大量用來標示區塊的起訖與用途。

新浪網原始碼中的 HTML 註解(綠色文字即為註解)

最基礎的功能:讓程式碼可被理解

註解會被瀏覽器忽略,寫在原始碼裡不會顯示於前端。但在大型、多人協作的專案中,如果沒有註解,甲工程師寫的程式碼就難以被乙工程師辨識;一旦甲離職,那部分程式碼幾乎無從維護。有了註解,理解的成本就大幅下降。

基本格式如下:

<!-- 這裡是註解文字 -->

<!--
  這裡也是註解文字
  換行了也沒問題
-->

進階用途一:保護頁內的 CSS 與 JavaScript

老舊瀏覽器或無法識別 CSS/JavaScript 的環境,若直接寫程式碼,往往會把內容當文字顯示出來,非常影響閱讀。看看下面的例子:

<!DOCTYPE html>
<html>
 <head>
 <style>
 body{color:#F00}
 </style>
 <script type="text/javascript">
 alert('歡迎訪問');
 </script>
 </head>
 <body>
 <p>Hello!</p>
 </body>
</html>

在部分舊版手機瀏覽器與 IE6 以下的版本中,會顯示成:

body{color:#F00} alert('歡迎訪問'); Hello!

這些瀏覽器不認識 <style> 與 <script> 標籤,依「不識別就不顯示」的原則,標籤本身確實不會出現,但標籤裡面的文字會被直接印出來。用註解包起來就能避免:

<!DOCTYPE html>
<html>
 <head>
 <style>
 <!--
 body{color:#F00}
 -->
 </style>
 <script type="text/javascript">
 <!--
 alert('歡迎訪問');
 -->
 </script>
 </head>
 <body>
 <p>Hello!</p>
 </body>
</html>

這是早期非常常見的寫法,如今已無必要,但理解它能幫助你讀懂老系統的程式碼。

進階用途二:在 MVC 樣板中標記可注入的位置

許多開源專案,特別是 MVC 架構的網頁程式,會先在 HTML 中插入特定形式的註解作為「插入點」,之後再由後端在這些位置填入廣告、統計碼或其他動態內容。

Discuz 利用 HTML 註解插入程式碼、判斷樣板區塊

寫註解的幾個原則

  • 解釋「為什麼」而不是「做了什麼」。程式碼本身已經說明了做法,註解該補的是背景與取捨。
  • 標示區塊邊界,例如 <!-- 導覽列 end -->,在層層嵌套的樣板裡特別有用。
  • 不要用註解藏敏感資訊。原始碼是會被公開的,API 金鑰、內部測試網址寫在註解裡等於公開發布。
  • 不要用註解保留大量舊程式碼。版本控制系統才是該做這件事的地方,被註解掉的程式碼只會製造混淆。
XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved