CSS 注释规范

2019-1-12 09:56| 作者: admin| 查看: 3303| 评论: 0|来自: 蚂蚁部落

良好的注释可以增加代码的可读性,也有利于后期维护。

一.单行注释:

通过如下语法结构形成一个单行注释:

[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代码,但是并不推荐使用。


鲜花

握手

雷人

路过

鸡蛋

最新评论

返回顶部