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

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

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

　　區域注釋

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

例：

...

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

　　單行注釋

　　注釋信息應寫在需注釋的內容區域里

例：

...

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

　　注釋層級

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

例：

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

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

　　協助注釋

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

　　例(區域注釋)：

...

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

例(單行注釋)：

...

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

網頁制作過程中應注意代碼注釋書寫規范，多多交流。

查看更多寧波網站建設網頁制作應注意注釋