網(wǎng)頁(yè)制作過(guò)程中代碼注釋書(shū)寫(xiě)規(guī)范是怎么樣的

小編給大家分享一下網(wǎng)頁(yè)制作過(guò)程中代碼注釋書(shū)寫(xiě)規(guī)范是怎么樣的，相信大部分人都還不怎么了解，因此分享這篇文章給大家參考一下，希望大家閱讀完這篇文章后大有收獲，下面讓我們一起去了解一下吧！

總結(jié)了一下自己工作中使用到的注釋書(shū)寫(xiě)規(guī)范，沒(méi)有什么技術(shù)含量，只是用于統(tǒng)一制作方式，方便維護(hù)。包含了“區(qū)域注釋”、“單行注釋”、“注釋層級(jí)”和“協(xié)助注釋”四個(gè)部分。
大部分同學(xué)使用的區(qū)域注釋的方法，會(huì)以“注釋內(nèi)容開(kāi)始”或“注釋內(nèi)容結(jié)束”、“start”或“end”等，相比之下，以“S”或“E”開(kāi)始可以更快的使用，比如只要寫(xiě)一次開(kāi)始或結(jié)束的注釋?zhuān)缓髲?fù)制，改下“S”或“E”就可以快速的完成區(qū)域的注釋。
區(qū)域注釋
在實(shí)際工作中，有時(shí)會(huì)出現(xiàn)分不清注釋?xiě)?yīng)該在標(biāo)簽之上還是標(biāo)簽之下，為了避免這種情況，注釋信息統(tǒng)一寫(xiě)在區(qū)域標(biāo)簽開(kāi)始之前和結(jié)束之后，并以“S”或“E”開(kāi)始，表示區(qū)域注釋的開(kāi)始或結(jié)束。
例：
<!--=S 注釋內(nèi)容-->
<div>
...
</div>
<!--=E 注釋內(nèi)容-->
/*=S 注釋內(nèi)容*/
.class{
...
}
.class{
...
}
/*=E 注釋內(nèi)容*/
單行注釋
注釋信息應(yīng)寫(xiě)在需注釋的內(nèi)容區(qū)域里
例：
<div>
<!--注釋內(nèi)容-->
...
</div>
.class{
/*注釋內(nèi)容*/
...
}                          

以上是“網(wǎng)頁(yè)制作過(guò)程中代碼注釋書(shū)寫(xiě)規(guī)范是怎么樣的”這篇文章的所有內(nèi)容，感謝各位的閱讀！相信大家都有了一定的了解，希望分享的內(nèi)容對(duì)大家有所幫助，如果還想學(xué)習(xí)更多知識(shí)，歡迎關(guān)注億速云行業(yè)資訊頻道！