DIV CSS 佈局教程網

 DIV+CSS佈局教程網 >> 網頁腳本 >> HTML基礎知識 >> HTML和Xhtml >> html、css和js注釋規范用法小結
html、css和js注釋規范用法小結
編輯:HTML和Xhtml     

添加必要的注釋,對一個有責任心、有道德模范的前端必須具備的好習慣,可以大大提高代碼的可維護性、可讀性。首先大家需要熟悉一下html、css、js的注釋的寫法:

html注釋:

<!--注釋內容-->

css注釋:

//注釋內容 單行注釋(不推薦使用,因為有的浏覽器可能不兼容,沒有效果)
/*注釋內容*/ 多行注釋(推薦使用)

JavaScript:

//注釋內容 單行注釋
/*注釋內容*/ 多行注釋

總結:

//注釋內容     (在css或javascript中插入單行注釋)
/*注釋內容*/   (在css或javascript中插入多行注釋)

接下來是對注釋在這幾種代碼中使用的位置,如何寫注釋進行總結一下。(根據個人的習慣可能不一樣)

1、html注釋

使用的位置:

1)一般會使用在一些主要節點標簽結束的後邊,如:

<div class="wrap">
<div class="main">
...
</div><!--main end-->
<div><!--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注釋規范用法小結,希望對大家有所幫助,如果大家有任何疑問請給我留言,小編會及時回復大家的。在此也非常感謝大家對網站的支持!

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved