良好的程式碼編寫風格能夠幫助我們在製作網頁的時候思路清晰,其中程式碼的註解也有一些小的學問。
我總結了一下自己工作中所使用的註釋書寫規範,其實也沒有什麼技術含量,主要是注意規範,便於統一製作方式,也方便維護。
這些經驗包含「區域註釋」、「單行註釋」、「註釋層級」和「協助註釋」四個部分。大部分朋友使用的區域註釋的方法會以「註釋內容開始」或「註釋內容結束」、「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{
/*註釋內容[修改人與修改時間]*/
……
}