CSS 注释规范
摘要:良好的注释可能添加代码的可读性,也无利于前期维护。一.单行注释:经过如下语法构造构成一个单行注释: /*注释
良好的注释可能添加代码的可读性,也无利于前期维护。
一.单行注释:
经过如下语法构造构成一个单行注释:
[CSS] 纯文本查看 复制代码
/* 注释内容 */星号与详细的注释内容之间利用一个空格分隔。
注释通常位于通常位于一段CSS代码上部,用于阐明此局部CSS代码的效用。
简略代码演示如下:
[CSS] 纯文本查看 复制代码
/* 评论 */ .comment{...} /* 相册 */ .photo{...} /* 分享 */ .share{...} /* 投票 */ .vote{...}二.多行注释:
CSS多行注释与单行注释采用相反的语法构造,只是将"*/"换行。
为了代码的美观,通常星号要一列对齐,且星号与内中之间有空格。
代码片段如下:
[CSS] 纯文本查看 复制代码
/** * HELLO素材网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代码,然而并不引荐利用。