html、css和js註釋的規範用法
阿新 • • 發佈：2017-05-15
ont alt 推薦 pan 文件 strong 服務 可用 如何
成為專業的前端工程師！！！
html註釋：
<!--註釋內容-->
css註釋：
//註釋內容 單行註釋（不推薦使用，因為有的瀏覽器可能不兼容，沒有效果）
/*註釋內容*/ 多行註釋（推薦使用）
JavaScript：
//註釋內容 單行註釋
/*註釋內容*/ 多行註釋
總結：
//註釋內容 （在css或javascript中插入單行註釋）
/*註釋內容*/ （在css或javascript中插入多行註釋)
接下來是對註釋在這幾種代碼中使用的位置，如何寫註釋進行總結一下。（根據個人的習慣可能不一樣）
1、html註釋
使用的位置：
1）一般會使用在一些主要節點標簽結束的後邊，如：
| 1 2 3 4 5 |
<p class="wrap">
<p class="main">
...
</p><!--main end-->
<p><!--wrap end-->
|
2）使用在一些循環的結束的後邊，如：
| 1 2 3 4 5 |
<ul class="list">
<li>111111</li>
<li>222222</li>
<li>333333</li>
</ul><!--list loop-->
|
這一切都是為了程序在嵌套的時候更加方便、明了。方便了他人同時也就方便了自己。程序嵌套的很亂，到時要你去修改那也是一份挺復雜的工序。
2、css註釋
一般會使用在定義某個模塊樣式的上邊，說明這段樣式是作用於哪段模塊，如：
| 1 2 3 4 5 6 7 8 |
/*通用 - 評論*/
.comment{...}
/*相冊*/
.photo{...}
/*分享*/
.share{...}
/*投票*/
.vote{...}
|
3、javascript註釋
一般將註釋添加在某段功能函數的上邊，說明函數的功能、作者、作者信息、修改時間。
| 1 2 3 4 5 6 |
//========================================================
// 截斷字符
// steepvi
// rtx:*******
// 2010-10-14
//========================================================
|
最後，註釋也是字符也是會有流量產生。因此當頁面發布到正式地址的時候，最好加上一步優化流程。
壓縮過程為非逆過程，保證本地是最新的而且帶有註釋的文件，壓縮後上傳服務器。服務器端的文件不可用作本地調試用。
html、css和js註釋的規範用法