CSS 註釋規範
良好的註釋可以增加程式碼的可讀性,也有利於後期維護。
一.單行註釋:
通過如下語法結構形成一個單行註釋:
[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程式碼,但是並不推薦使用。
相關文章
- golang 註釋規範Golang
- JavaScript 註釋規範JavaScript
- HTML 程式碼註釋規範HTML
- Java程式碼註釋規範Java
- java快捷鍵和註釋規範Java
- 前端規範之CSS規範前端CSS
- PHP程式碼常用註釋規範(PHP Doc)PHP
- 前端開發規範:命名規範、html規範、css規範、js規範前端HTMLCSSJS
- 編碼規範系列:css規範CSS
- RFC1867(請求註釋)規範 (轉)
- [規範] CSS BEMCSS
- CSS命名規範CSS
- 『前端規範化』CSS命名規範化前端CSS
- 前端規範與思考(二)———css規範前端CSS
- 前端規範之CSS規範(Stylelint)前端CSS
- Golang 註釋規範-類、函式、結構體等Golang函式結構體
- 按照 Promise/A+ 規範逐行註釋並實現 PromisePromise
- CSS編碼規範CSS
- CSS — BEM 命名規範CSS
- css 命名規範 BEMCSS
- Scoped CSS規範草案CSS
- 谷歌 HTML/CSS 規範谷歌HTMLCSS
- css程式碼規範CSS
- css書寫規範CSS
- CSS-reset&規範CSS
- CSS2規範CSS
- CSS1規範CSS
- 匹配css程式碼註釋的正規表示式CSS
- git 提交備註規範Git
- 批量修改行尾註釋(程式碼規範檢查中)
- Css規範整理:2、css盒模型CSS模型
- CSS 程式碼格式規範CSS
- css BEM書寫規範CSS
- HTML,CSS編碼規範HTMLCSS
- CSS規範 - 最佳實踐CSS
- 年前整理的Css規範CSS
- div+css命名規範CSS
- css之編寫規範CSS