武林網(wǎng)(m.survivalescaperooms.com)文章簡(jiǎn)介：總結(jié)了一下自己工作中使用到的注釋書(shū)寫(xiě)規(guī)范，沒(méi)有什么技術(shù)含量，只是用于統(tǒng)一制作方式，方便維護(hù)。包含了“區(qū)域注釋”、“單行注釋”、“注釋層級(jí)”和“協(xié)助注釋”四個(gè)部分。

總結(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)容 */
...
}

注釋層級(jí)
在模塊制作中，可能會(huì)出現(xiàn)區(qū)域中還有區(qū)域的情況，為了更好的區(qū)分區(qū)域之間的層級(jí)，引入了注釋層級(jí)的概念。

區(qū)域注釋前面的等號(hào)表示了當(dāng)前注釋的層級(jí)

例：

<!--=S 注釋內(nèi)容 -->
...
  <!--==S 注釋內(nèi)容 -->
  ...
    <!--===S 注釋內(nèi)容 -->
    ...
    <!--===E 注釋內(nèi)容 -->
  ...
  <!--==E 注釋內(nèi)容 -->
...
<!--=E 注釋內(nèi)容 -->

/*=S 注釋內(nèi)容 */
...
/*==S 注釋內(nèi)容 */
...
/*===S 注釋內(nèi)容 */
...
/*===E 注釋內(nèi)容 */
...
/*==E 注釋內(nèi)容 */
...
/*=E 注釋內(nèi)容 */

協(xié)助注釋
非作者維護(hù)時(shí)所加入的表示修改時(shí)間、修改人等標(biāo)識(shí)信息。

在區(qū)域注釋或單行注釋的基礎(chǔ)上加上修改人和修改時(shí)間等信息。

例(區(qū)域注釋)：

<!--==S 注釋內(nèi)容[修改人和修改時(shí)間] -->
<div>
...
</div>
<!--==E 注釋內(nèi)容[修改人和修改時(shí)間] -->

/*=S 注釋內(nèi)容[修改人和修改時(shí)間] */
.class{
...
}
.class{
...
}
/*=E 注釋內(nèi)容[修改人和修改時(shí)間] */

例(單行注釋)：

<div>
<!-- 注釋內(nèi)容[修改人和修改時(shí)間] -->
...
</div>

.class{
/* 注釋內(nèi)容[修改人和修改時(shí)間] */
...
}

須要注意注釋標(biāo)記的開(kāi)始和結(jié)束（特別是樣式中的單行注釋?zhuān)r(shí)，注釋內(nèi)容跟標(biāo)記間應(yīng)該加上空格，避免IE下出現(xiàn)讀取不到內(nèi)容的情況。