DIV CSS 佈局教程網

您现在的位置: DIV+CSS佈局教程網 >> 網頁腳本 >  >> WEB網站前端 >> 關於網頁技巧
網頁製作中的程式碼註解規範:區域、單行、層級與協助註解
編輯:關於網頁技巧     

以下是我在實際工作中整理出的註解書寫規範,技術含量不高,目的只是統一寫法、方便後續維護,共分四個部分。

區域註解

不少人習慣寫「註解內容開始/結束」或 start/end。相比之下,用 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{
/*註解內容[修改人和修改時間]*/
...
}

規範本身不難,真正的價值在於全團隊照著同一套寫——三個月後回頭看程式碼,你會感謝現在的自己。

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