1.注释的目的:
提高代码的可读性,从而提高代码的可维护性
注释的原则:
如无必要,勿增注释 ( As short as possible )
如有必要,尽量详尽 ( As long as necessary )
css
/*< 样式简介注释 >*/
#header {
width:100%; /* 属性提示注释 */
height:90px; /* 属性提示注释 */
background-position:center center; /* 属性提示注释 */
background-repeat:no-repeat; /* 属性提示注释 */
/*background-repeat: repeat;备用声明注释 */
}
1.1单行注释
注释内容第一个字符和最后一个字符都是一个空格字符,单独占一行,行与行之间相隔一行。
/* Comment Text */
.jdc {}
/* Comment Text */
.jdc {}
模块注释
注释内容第一个字符和最后一个字符都是一个空格字符,
/* 与 模块信息描述占一行,
多个横线分隔符 - 与 */ 占一行,
行与行之间相隔两行。
/* Module A
---------------------------------------------------------------- */
.mod_a {}
/* Module B
---------------------------------------------------------------- */
.mod_b {}
1.3文件注释
页面名称、作者、创建日期等信息
@charset “UTF-8”;
/**
* @desc File Info
* @author Author Name
* @date 2015-10-10
*/