-
自然排名 點擊多少均不要錢喲！
可能會幫您的生意提高幾倍，幾十倍 -
良好的代碼編寫風(fēng)格能夠幫助我們在制作網(wǎng)頁的時候思路清晰，其中代碼的注釋也有一些小的學(xué)問。
我總結(jié)了一下自己工作中使用到的注釋書寫規(guī)范，其實也沒有什么技術(shù)含量，主要是注意規(guī)范，便于統(tǒng)一制作方式，也方便維護(hù)。
這些經(jīng)驗包含“區(qū)域注釋”、“單行注釋”、“注釋層級”和“協(xié)助注釋”四個部分。大部分朋友使用的區(qū)域注釋的方法會以“注釋內(nèi)容開始”或“注釋內(nèi)容結(jié)束”、“start”或“end”等，相比之下，以“S”或“E”開始可以更快的使用，比如只要寫一次開始或結(jié)束的注釋，然后復(fù)制，改下“S”或“E”就可以快速的完成區(qū)域的注釋。
區(qū)域注釋
在實際工作中，有時會出現(xiàn)分不清注釋應(yīng)該在標(biāo)簽之上還是標(biāo)簽之下，為了避免這種情況，注釋信息統(tǒng)一寫在區(qū)域標(biāo)簽開始之前和結(jié)束之后，并以“S”或“E”開始，表示區(qū)域注釋的開始或結(jié)束。
例：
...
/*=S 注釋內(nèi)容*/
.class{
...
}
.class{
...
}
/*=E 注釋內(nèi)容*/
單行注釋
注釋信息應(yīng)寫在需注釋的內(nèi)容區(qū)域里
例：
...
.class{
/*注釋內(nèi)容*/
...
}
注釋層級
在模塊制作中，可能會出現(xiàn)區(qū)域中還有區(qū)域的情況，為了更好的區(qū)分區(qū)域之間的層級，引入了注釋層級的概念。區(qū)域注釋前面的等號表示了當(dāng)前注釋的層級
例：
...
...
...
...
...
/*=S 注釋內(nèi)容*/
...
/*==S 注釋內(nèi)容*/
...
/*===S 注釋內(nèi)容*/
...
/*===E 注釋內(nèi)容*/
...
/*==E 注釋內(nèi)容*/
...
/*=E 注釋內(nèi)容*/
協(xié)助注釋
非作者維護(hù)時所加入的表示修改時間、修改人等標(biāo)識信息。在區(qū)域注釋或單行注釋的基礎(chǔ)上加上修改人和修改時間等信息。
例(區(qū)域注釋)：
...
/*=S 注釋內(nèi)容[修改人和修改時間]*/
.class{
...
}
.class{
...
}
/*=E 注釋內(nèi)容[修改人和修改時間]*/
例(單行注釋)：
...
.class{
/*注釋內(nèi)容[修改人和修改時間]*/
...
}
網(wǎng)頁制作過程中應(yīng)注意代碼注釋書寫規(guī)范，多多交流。
