注释规范

Tips

京东凹凸实验室前端开发规范;

内容 👹

• 注释以字符 /* 开始，以字符 */ 结束
• 注释不能嵌套

/*Comment Text*/

单行注释

• 注释内容第一个字符和最后一个字符都是一个空格字符，单独占一行，行与行之间相隔一行

正例

/* Comment Text */
.jdc{}

/* Comment Text */
.jdc{}

反例

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

模块注释

注释内容第一个字符和最后一个字符都是一个空格字符，/* 与 模块信息描述占一行，多个横线分隔符-与*/占一行，行与行之间相隔两行

正例

/* Module A
---------------------------------------------------------------- */
.mod_a {}


/* Module B
---------------------------------------------------------------- */
.mod_b {}
.jdc{}

反例

/* Module A ---------------------------------------------------- */
.mod_a {}
/* Module B ---------------------------------------------------- */
.mod_b {}

文件信息注释

在样式文件编码声明 @charset 语句下面注明页面名称、作者、创建日期等信息

@charset "UTF-8";
/**
 * @desc File Info
 * @author Author Name
 * @date 2015-10-10
 */