# 注释规范
Comments begin with the characters
/*
and end with the characters*/
. They may occur anywhere outside other tokens, and their contents have no influence on the rendering. Comments may not be nested.
- 注释以字符
/*
开始,以字符*/
结束 - 注释不能嵌套
/*Comment Text*/
1
# 团队约定
# 单行注释
注释内容第一个字符和最后一个字符都是一个空格字符,单独占一行,行与行之间相隔一行
推荐:
/* Comment Text */
.jdc {
}
/* Comment Text */
.jdc {
}
1
2
3
4
5
6
7
2
3
4
5
6
7
不推荐:
/*Comment Text*/
.jdc {
display: block;
}
.jdc {
display: block; /*Comment Text*/
}
1
2
3
4
5
6
7
2
3
4
5
6
7
# 模块注释
注释内容第一个字符和最后一个字符都是一个空格字符,/*
与 模块信息描述占一行,多个横线分隔符-
与*/
占一行,行与行之间相隔两行
推荐:
/* Module A
---------------------------------------------------------------- */
.mod-a {
}
/* Module B
---------------------------------------------------------------- */
.mod-b {
}
1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
不推荐:
/* Module A ---------------------------------------------------- */
.mod-a {
}
/* Module B ---------------------------------------------------- */
.mod-b {
}
1
2
3
4
5
6
2
3
4
5
6
# 文件信息注释
在样式文件编码声明 @charset
语句下面注明页面名称、作者、创建日期等信息
@charset "UTF-8";
/**
* @desc File Info
* @author Author Name
* @date 2015-10-10
*/
1
2
3
4
5
6
2
3
4
5
6
更多关于 CSS 注释:#Comments (opens new window)