CSS 注釋規(guī)范

2020-09-09 14:18 更新
Comments begin with the characters /* and end with the characters */. They may occur anywhere outside other tokens, and their contents have no influence on the rendering. Comments may not be nested.
  • 注釋以字符 /* 開始,以字符 */ 結(jié)束
  • 注釋不能嵌套
/*Comment Text*/

團(tuán)隊(duì)約定

單行注釋

注釋內(nèi)容第一個(gè)字符和最后一個(gè)字符都是一個(gè)空格字符,單獨(dú)占一行,行與行之間相隔一行

推薦:

/* Comment Text */
.jdc{}
?
/* Comment Text */
.jdc{}

不推薦:

/*Comment Text*/
.jdc{
display: block;
}
.jdc{
display: block;/*Comment Text*/
}

模塊注釋

注釋內(nèi)容第一個(gè)字符和最后一個(gè)字符都是一個(gè)空格字符,/* 與 模塊信息描述占一行,多個(gè)橫線分隔符-*/占一行,行與行之間相隔兩行

推薦:

/* Module A
---------------------------------------------------------------- */
.mod_a {}
?
?
/* Module B
---------------------------------------------------------------- */
.mod_b {}

不推薦:

/* Module A ---------------------------------------------------- */
.mod_a {}
/* Module B ---------------------------------------------------- */
.mod_b {}

文件信息注釋

在樣式文件編碼聲明 @charset 語句下面注明頁面名稱、作者、創(chuàng)建日期等信息

@charset "UTF-8";
/**
* @desc File Info
* @author Author Name
* @date 2015-10-10
*/

更多關(guān)于 CSS 注釋:#Comments


以上內(nèi)容是否對(duì)您有幫助:
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號(hào)
微信公眾號(hào)

編程獅公眾號(hào)