DIV CSS 佈局教程網

 DIV+CSS佈局教程網 >> 網頁腳本 >> CSS入門知識 >> CSS進階教程 >> CSS樣式表注釋書寫規范
CSS樣式表注釋書寫規范
編輯:CSS進階教程     

總結了一下自己工作中使用到的注釋書寫規范,沒有什麼技術含量,只是用於統一制作方式,方便維護。包含了“區域注釋”、“單行注釋”、“注釋層級”和“協助注釋”四個部分。

如果大家有其它的建議,歡迎留言。

大部分同學使用的區域注釋的方法,會以“注釋內容開始”或“注釋內容結束”、“start”或“end”等,相比之下,以“S”或“E”開始可以更快的使用,比如只要寫一次開始或結束的注釋,然後復制,改下“S”或“E”就可以快速的完成區域的注釋。

區域注釋
在實際工作中,有時會出現分不清注釋應該在標簽之上還是標簽之下,為了避免這種情況,注釋信息統一寫在區域標簽開始之前和結束之後,並以“S”或“E”開始,表示區域注釋的開始或結束。

例:


<!--=S 注釋內容 -->
<div>
...
</div>
<!--=E 注釋內容 -->

 

/*=S 注釋內容 */
.class{
...
}
.class{
...
}
/*=E 注釋內容 */


單行注釋
注釋信息應寫在需注釋的內容區域裡

例:


<div>
<!-- 注釋內容 -->
...
</div>

 

.class{
/* 注釋內容 */
...
}


注釋層級
在模塊制作中,可能會出現區域中還有區域的情況,為了更好的區分區域之間的層級,引入了注釋層級的概念。

區域注釋前面的等號表示了當前注釋的層級

例:


<!--=S 注釋內容 -->
...
  <!--==S 注釋內容 -->
  ...
    <!--===S 注釋內容 -->
    ...
    <!--===E 注釋內容 -->
  ...
  <!--==E 注釋內容 -->
...
<!--=E 注釋內容 -->

 

/*=S 注釋內容 */
...
/*==S 注釋內容 */
...
/*===S 注釋內容 */
...
/*===E 注釋內容 */
...
/*==E 注釋內容 */
...
/*=E 注釋內容 */


協助注釋
非作者維護時所加入的表示修改時間、修改人等標識信息。

在區域注釋或單行注釋的基礎上加上修改人和修改時間等信息。

例(區域注釋):


<!--==S 注釋內容[修改人和修改時間] -->
<div>
...
</div>
<!--==E 注釋內容[修改人和修改時間] -->

 

/*=S 注釋內容[修改人和修改時間] */
.class{
...
}
.class{
...
}
/*=E 注釋內容[修改人和修改時間] */


例(單行注釋):


<div>
<!-- 注釋內容[修改人和修改時間] -->
...
</div>

 

.class{
/* 注釋內容[修改人和修改時間] */
...
}


須要注意注釋標記的開始和結束(特別是樣式中的單行注釋)時,注釋內容跟標記間應該加上空格,避免IE下出現讀取不到內容的情況。

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