網(wǎng)頁制作過程中代碼注釋書寫規(guī)范

2024-08-30 08:33:40

字體：大中小

供稿：網(wǎng)友

總結(jié)了一下自己工作中使用到的注釋書寫規(guī)范，沒有什么技術含量，只是用于統(tǒng)一制作方式，方便維護。包含了“區(qū)域注釋”、“單行注釋”、“注釋層級”和“協(xié)助注釋”四個部分。
大部分同學使用的區(qū)域注釋的方法，會以“注釋內(nèi)容開始”或“注釋內(nèi)容結(jié)束”、“start”或“end”等，相比之下，以“S”或“E”開始可以更快的使用，比如只要寫一次開始或結(jié)束的注釋，然后復制，改下“S”或“E”就可以快速的完成區(qū)域的注釋。
區(qū)域注釋
在實際工作中，有時會出現(xiàn)分不清注釋應該在標簽之上還是標簽之下，為了避免這種情況，注釋信息統(tǒng)一寫在區(qū)域標簽開始之前和結(jié)束之后，并以“S”或“E”開始，表示區(qū)域注釋的開始或結(jié)束。
例：

<div>
...
</div>

/*=S 注釋內(nèi)容*/
.class{
...
}
.class{
...
}
/*=E 注釋內(nèi)容*/
單行注釋
注釋信息應寫在需注釋的內(nèi)容區(qū)域里
例：
<div>

...
</div>
.class{
/*注釋內(nèi)容*/
...
}

上一篇：中文網(wǎng)頁內(nèi)容表現(xiàn)的十條經(jīng)驗

下一篇：暈倒：“用web2.0來制作符合標準的頁面”