添加必要的注釋,對(duì)一個(gè)有責(zé)任心、有道德模范的前端必須具備的好習(xí)慣,可以大大提高代碼的可維護(hù)性、可讀性。首先大家需要熟悉一下html、css、js的注釋的寫法:
html注釋:
!--注釋內(nèi)容--
css注釋:
//注釋內(nèi)容 單行注釋(不推薦使用,因?yàn)橛械?a href='http://www.companysz.com/tag/liulanqi_7527_1.html' target='_blank'>瀏覽器可能不兼容,沒有效果)/*注釋內(nèi)容*/ 多行注釋(推薦使用)
JavaScript:
//注釋內(nèi)容 單行注釋/*注釋內(nèi)容*/ 多行注釋
總結(jié):
//注釋內(nèi)容 (在css或javascript中插入單行注釋)/*注釋內(nèi)容*/ (在css或javascript中插入多行注釋)
接下來是對(duì)注釋在這幾種代碼中使用的位置,如何寫注釋進(jìn)行總結(jié)一下。(根據(jù)個(gè)人的習(xí)慣可能不一樣)
1、html注釋
使用的位置:
1)一般會(huì)使用在一些主要節(jié)點(diǎn)標(biāo)簽結(jié)束的后邊,如:
div >
2)使用在一些循環(huán)的結(jié)束的后邊,如:
ul >
這一切都是為了程序在嵌套的時(shí)候更加方便、明了。方便了他人同時(shí)也就方便了自己。程序嵌套的很亂,到時(shí)要你去修改那也是一份挺復(fù)雜的工序。
2、css注釋
一般會(huì)使用在定義某個(gè)模塊樣式的上邊,說明這段樣式是作用于哪段模塊,如:
/*通用 - 評(píng)論*/.comment{...}/*相冊(cè)*/.photo{...}/*分享*/.share{...}/*投票*/.vote{...}
3、javascript注釋
一般將注釋添加在某段功能函數(shù)的上邊,說明函數(shù)的功能、作者、作者信息、修改時(shí)間。
//========================================================// 截?cái)嘧址?/ steepvi// rtx:*******// 2010-10-14//========================================================
最后,注釋也是字符也是會(huì)有流量產(chǎn)生。因此當(dāng)頁面發(fā)布到正式地址的時(shí)候,最好加上一步優(yōu)化流程。
壓縮過程為非逆過程,保證本地是最新的而且?guī)в凶⑨尩奈募?,壓縮后上傳服務(wù)器。服務(wù)器端的文件不可用作本地調(diào)試用。
相信看了這些案例你已經(jīng)掌握了方法,更多精彩請(qǐng)關(guān)注php 其它相關(guān)文章!
相關(guān)閱讀:
HTML圖片的img標(biāo)簽怎樣使用
HTML5的WEB界面中meta實(shí)列詳解
HTML中如何使用html表單提交的操作
以上就是html、css和js的注釋規(guī)范用法有哪些的詳細(xì)內(nèi)容,html教程
鄭重聲明:本文版權(quán)歸原作者所有,轉(zhuǎn)載文章僅為傳播更多信息之目的,如作者信息標(biāo)記有誤,請(qǐng)第一時(shí)間聯(lián)系我們修改或刪除,多謝。
新聞熱點(diǎn)
疑難解答