加入必要的註釋,對一個有責任心、有道德模範的前端必須具備的好習慣,可以大大提高程式碼的可維護性、可讀性。下面小編跟大家介紹下html、css和js註釋規範用法小結,需要的的朋友參考下吧
#添加必要的註釋,對一個有責任心、有道德模範的前端必須具備的好習慣,可以大大提高程式碼的可維護性、可讀性。首先大家需要熟悉html、css、js的註解的寫法:
html註解:
css註解:
//註解內容單行註解(不建議使用,因為有的瀏覽器可能不相容,沒有效果)
/*註解內容*/多行註解(建議使用)
JavaScript:
//註解內容單行註解
/*註解內容*/ 多行註解
總結:
//註解內容 (在css或javascript插入單行註解)
/*註解內容*/ (css或javascript插入多行註解)
接下來是將註解在這幾種程式碼中使用的位置,如何寫註解進行總結。 (根據個人的習慣可能不一樣)
1、html註解
#使用的位置:
1)一般會使用在一些主要節點標籤結束的後邊,如:
<p class="wrap"> <p class="main"> ... </p><!--main end--> <p><!--wrap end-->
2)使用在一些迴圈的結束的後邊,如:
<ul class="list"> <li>111111</li> <li>222222</li> <li>333333</li> </ul><!--list loop-->
這一切都是為了程式在嵌套的時候更加方便、明了。方便了他人同時也就方便了自己。程式嵌套的很亂,到時要你去修改那也是一份挺複雜的工序。
2、css註解
一般會使用在定義某個模組樣式的上邊,說明這段樣式是作用於哪段模組,如:
/*通用 - 评论*/ .comment{...} /*相册*/ .photo{...} /*分享*/ .share{...} /*投票*/ .vote{...}
3、javascript註解
#一般將註解加入某段功能函數的上邊,說明函數的功能、作者、作者訊息、修改時間。
//======================================================== // 截断字符 // steepvi // rtx:******* // 2010-10-14 //========================================================
最後,註解也是字元也是會有流量產生。因此當頁面發佈到正式地址的時候,最好再加一步優化流程。
壓縮過程為非逆過程,保證本地是最新的且帶有註解的文件,壓縮後上傳伺服器。伺服器端的檔案不可用作本機偵錯用。
以上是你必須了解的html、css和js註解規範用法的詳細內容。更多資訊請關注PHP中文網其他相關文章!