CSS 註釋規範

admin發表於2019-01-12

良好的註釋可以增加程式碼的可讀性,也有利於後期維護。

一.單行註釋:

通過如下語法結構形成一個單行註釋:

[CSS] 純文字檢視 複製程式碼
/* 註釋內容 */

星號與具體的註釋內容之間使用一個空格分隔。

註釋通常位於通常位於一段CSS程式碼上部,用於說明此部分CSS程式碼的功效。

簡單程式碼演示如下:

[CSS] 純文字檢視 複製程式碼
/* 評論 */
.comment{...}
/* 相簿 */
.photo{...}
/* 分享 */
.share{...}
/* 投票 */
.vote{...}

二.多行註釋:

CSS多行註釋與單行註釋採用相同的語法結構,只是將"*/"換行。

為了程式碼的美觀,通常星號要一列對齊,且星號與內中之間有空格。

程式碼片段如下:

[CSS] 純文字檢視 複製程式碼
/**
 * 螞蟻部落CSS教程
 */

三.CSS檔案註釋:

一個CSS獨立檔案頂部通常有對此檔案的一些描述資訊。

[CSS] 純文字檢視 複製程式碼
/**
 * @name: 檔名或模組名
 * @description: 檔案或模組描述
 * @author: author-name(mail-name@softwhy.com)
 *          author-name2(mail-name2@softwhy.com)
 * @update: 2019-01-12 01:02
 */

上面是註釋格式的一些樣例,其實資訊可以更多一些,根據情況自定義。

特別說明:在當前大部分瀏覽器中,使用<!-- 註釋內容 -->也可以註釋CSS程式碼,但是並不推薦使用。

相關文章