網頁製作過程中代碼注釋書寫規範

來源:互聯網
上載者:User

總結了一下自己工作中使用到的注釋書寫規範,沒有什麼技術含量,只是用於統一製作方式,方便維護。包含了“地區注釋”、“單行注釋”、“注釋層級”和“協助注釋”四個部分。

大部分同學使用的地區注釋的方法,會以“注釋內容開始”或“注釋內容結束”、“start”或“end”等,相比之下,以“S”或“E”開始可以更快的使用,比如只要寫一次開始或結束的注釋,然後複製,改下“S”或“E”就可以快速的完成地區的注釋。

地區注釋

在實際工作中,有時會出現分不清注釋應該在標籤之上還是標籤之下,為了避免這種情況,注釋資訊統一寫在地區標籤開始之前和結束之後,並以“S”或“E”開始,表示地區注釋的開始或結束。

例:

<!--=S 注釋內容-->
<div>
...
</div>
<!--=E 注釋內容-->

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

單行注釋

注釋資訊應寫在需注釋的內容地區裡

例:

<div>
<!--注釋內容-->
...
</div>

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



相關文章

E-Commerce Solutions

Leverage the same tools powering the Alibaba Ecosystem

Learn more >

Apsara Conference 2019

The Rise of Data Intelligence, September 25th - 27th, Hangzhou, China

Learn more >

Alibaba Cloud Free Trial

Learn and experience the power of Alibaba Cloud with a free trial worth $300-1200 USD

Learn more >

聯繫我們

該頁面正文內容均來源於網絡整理,並不代表阿里雲官方的觀點,該頁面所提到的產品和服務也與阿里云無關,如果該頁面內容對您造成了困擾,歡迎寫郵件給我們,收到郵件我們將在5個工作日內處理。

如果您發現本社區中有涉嫌抄襲的內容,歡迎發送郵件至: info-contact@alibabacloud.com 進行舉報並提供相關證據,工作人員會在 5 個工作天內聯絡您,一經查實,本站將立刻刪除涉嫌侵權內容。