html、css和js注釋規(guī)范用法小結(jié)
添加必要的注釋,對一個有責(zé)任心、有道德模范的前端必須具備的好習(xí)慣,可以大大提高代碼的可維護(hù)性、可讀性。首先大家需要熟悉一下html、css、js的注釋的寫法:
html注釋:
<!--注釋內(nèi)容-->
css注釋:
//注釋內(nèi)容 單行注釋(不推薦使用,因?yàn)橛械臑g覽器可能不兼容,沒有效果)
/*注釋內(nèi)容*/ 多行注釋(推薦使用)
JavaScript:
//注釋內(nèi)容 單行注釋
/*注釋內(nèi)容*/ 多行注釋
總結(jié):
//注釋內(nèi)容 (在css或javascript中插入單行注釋)
/*注釋內(nèi)容*/ (在css或javascript中插入多行注釋)
接下來是對注釋在這幾種代碼中使用的位置,如何寫注釋進(jìn)行總結(jié)一下。(根據(jù)個人的習(xí)慣可能不一樣)
1、html注釋
使用的位置:
1)一般會使用在一些主要節(jié)點(diǎn)標(biāo)簽結(jié)束的后邊,如:
<div class="wrap"> <div class="main"> ... </div><!--main end--> <div><!--wrap end-->
2)使用在一些循環(huán)的結(jié)束的后邊,如:
<ul class="list"> <li>111111</li> <li>222222</li> <li>333333</li> </ul><!--list loop-->
這一切都是為了程序在嵌套的時候更加方便、明了。方便了他人同時也就方便了自己。程序嵌套的很亂,到時要你去修改那也是一份挺復(fù)雜的工序。
2、css注釋
一般會使用在定義某個模塊樣式的上邊,說明這段樣式是作用于哪段模塊,如:
/*通用 - 評論*/ .comment{...} /*相冊*/ .photo{...} /*分享*/ .share{...} /*投票*/ .vote{...}
3、javascript注釋
一般將注釋添加在某段功能函數(shù)的上邊,說明函數(shù)的功能、作者、作者信息、修改時間。
//======================================================== // 截斷字符 // steepvi // rtx:******* // 2010-10-14 //========================================================
最后,注釋也是字符也是會有流量產(chǎn)生。因此當(dāng)頁面發(fā)布到正式地址的時候,最好加上一步優(yōu)化流程。
壓縮過程為非逆過程,保證本地是最新的而且?guī)в凶⑨尩奈募?,壓縮后上傳服務(wù)器。服務(wù)器端的文件不可用作本地調(diào)試用。
以上所述是小編給大家介紹的html、css和js注釋規(guī)范用法小結(jié),希望對大家有所幫助,如果大家有任何疑問請給我留言,小編會及時回復(fù)大家的。在此也非常感謝大家對我們網(wǎng)站的支持!
上一篇:在HTML中使用JavaScript實(shí)例代碼
欄 目:CSS/HTML
下一篇:Html 實(shí)現(xiàn)動態(tài)顯示顏色塊的報表效果(實(shí)例代碼)
本文標(biāo)題:html、css和js注釋規(guī)范用法小結(jié)
本文地址:http://mengdiqiu.com.cn/a1/CSS_HTML/9572.html
您可能感興趣的文章


閱讀排行
本欄相關(guān)
- 04-02表格樣式css樣式,css樣式表單
- 04-02好看的字體樣式css,好看的字體樣式圖
- 04-02分頁樣式css,分頁樣式j(luò)q
- 04-02分頁樣式css,分頁樣式欄里用來定義首
- 04-02css樣式的引入,css樣式怎么引入
- 04-02css滾動條樣式,css滾動條的樣式
- 04-02css樣式引入方式有幾種,網(wǎng)頁引入css樣
- 04-02html中加入css樣式的簡單介紹
- 04-02vue中的css樣式布局,vue添加css樣式
- 04-02內(nèi)嵌樣式css,內(nèi)嵌樣式表,內(nèi)部樣式表
隨機(jī)閱讀
- 01-10C++ 類訪問控制的條件總結(jié)
- 01-10C++實(shí)現(xiàn)將數(shù)組中的值反轉(zhuǎn)
- 08-05dedecms織夢模板全站調(diào)用收藏數(shù)的方法
- 01-10C語言打印楊輝三角示例匯總
- 01-10vue實(shí)現(xiàn)分頁加載效果
- 08-05DEDECMS點(diǎn)擊主欄目默認(rèn)顯示第一個子欄
- 01-11常用的HTML富文本編譯器UEditor、CKEdi
- 01-10bat批處理徹底隱藏文件的方法(使用
- 08-05dedecms織夢模板編輯文檔的同時自動更
- 08-05織夢dedecms首頁調(diào)用縮略圖為背景