lixiangni

　　良好的代碼編寫風格能夠幫助我們在製作網頁的時候思路清晰，其中代碼的註釋也有一些小的學問。

　　我總結了一下自己工作中使用到的註釋書寫規範，其實也沒有什麼技術含量，主要是注意規範，便於統一製作方式，也方便維護。

　　這些經驗包含“區域註釋”、“單行註釋”、“註釋層級”和“協助註釋”四個部分。大部分朋友使用的區域註釋的方法會以“註釋內容開始”或“註釋內容結束”、“start”或“end”等，相比之下，以“S”或“E”開始可以更快的使用，比如只要寫一次開始或結束的註釋，然後複製，改下“S”或“E”就可以快速的完成區域的註釋。

　　區域註釋

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

例：

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

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

　　單行註釋

　　註釋信息應寫在需註釋的內容區域裡

例：

<div>

...
</div>

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

　　註釋層級

　　在模塊製作中，可能會出現區域中還有區域的情況，為了更好的區分區域之間的層級，引入了註釋層級的概念。區域註釋前面的等號表示了當前註釋的層級

例：

...
 
  ...
   
    ...
   
  ...
 
...

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

　　協助註釋

　　非作者維護時所加入的表示修改時間、修改人等標識信息。在區域註釋或單行註釋的基礎上加上修改人和修改時間等信息。

　　例(區域註釋)：

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

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

例(單行註釋)：

<div>

...
</div>

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