html、css和js注釋的規范用法


成為專業的前端工程師!!!

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
//========================================================

 

最后,注釋也是字符也是會有流量產生。因此當頁面發布到正式地址的時候,最好加上一步優化流程。

壓縮過程為非逆過程,保證本地是最新的而且帶有注釋的文件,壓縮后上傳服務器。服務器端的文件不可用作本地調試用。


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM