CSS 注釋規(guī)范

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

團隊約定

單行注釋

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

推薦：

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

不推薦：

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

模塊注釋

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

推薦：

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