首頁  >  文章  >  web前端  >  html、css和js的註解規範用法有哪些

html、css和js的註解規範用法有哪些

php中世界最好的语言
php中世界最好的语言原創
2018-01-18 09:28:371968瀏覽

這次帶給大家html、css和js的註解規格用法有哪些,使用html、css和js的註解有哪些的注意事項有哪些,下面就是實戰案例,一起來看一下。

加入必要的註釋,對一個有責任心、有道德模範的前端必須具備的好習慣,可以大大提高程式碼的可維護性、可讀性。首先大家需要熟悉html、css、js的註解的寫法:

html註解

<!--注释内容-->

css註解:

//注释内容 单行注释(不推荐使用,因为有的浏览器可能不兼容,没有效果)
/*注释内容*/ 多行注释(推荐使用)

# JavaScript

//注释内容 单行注释/*注释内容*/ 多行注释

總結:

//注释内容     (在css或javascript中插入单行注释)/*注释内容*/   (在css或javascript中插入多行注释)

接下來是對註解在這幾種程式碼中使用的位置,如何寫註解進行總結。 (根據個人的習慣可能不一樣)

1、html註解

使用的位置:

1)一般會使用在一些主要節點標籤結束的後邊,如: 

<div class="wrap">
<div class="main">
...
</div><!--main end-->
<div><!--wrap end-->


2)使用在某些循環的結束的後邊,如: 

<ul class="list">
    <li>111111</li>
    <li>222222</li>
    <li>333333</li>
</ul><!--list loop-->


##這一切都是為了程式在嵌套的時候更加方便、明了。方便了他人同時也就方便了自己。程式嵌套的很亂,到時要你去修改那也是一份挺複雜的工序。

2、css註解

通常會使用在定義某個模組樣式的上邊,說明這段樣式是作用於哪段模組,如: 

/*通用 - 评论*/
.comment{...}
/*相册*/
.photo{...}
/*分享*/
.share{...}
/*投票*/
.vote{...}


3、javascript註解

一般將註解加入某段功能

函數的上邊,說明函數的功能、作者、作者資訊、修改時間。 

//========================================================
//      截断字符
//      steepvi
//      rtx:*******
//      2010-10-14
//========================================================


最後,註解也是字元也是會有流量產生。因此當頁面發佈到正式地址的時候,最好再加一步優化流程。


壓縮過程為非逆過程,保證本地是最新的且帶有註解的文件,壓縮後

上傳伺服器。伺服器端的檔案不可用作本機偵錯用。

相信看了這些案例你已經掌握了方法,更多精彩請關注php中文網其它相關文章!

相關閱讀:

HTML圖片的img標籤怎樣使用

HTML5的WEB介面中meta實列詳解

HTML中如何使用html表單提交的動作
#

以上是html、css和js的註解規範用法有哪些的詳細內容。更多資訊請關注PHP中文網其他相關文章!

陳述:
本文內容由網友自願投稿,版權歸原作者所有。本站不承擔相應的法律責任。如發現涉嫌抄襲或侵權的內容,請聯絡admin@php.cn