1.注释的目的:

提高代码的可读性,从而提高代码的可维护性

注释的原则:

如无必要,勿增注释 ( As short as possible )

如有必要,尽量详尽 ( As long as necessary )

css

  1. /*< 样式简介注释 >*/
  2. #header {
  3. width:100%; /* 属性提示注释 */
  4. height:90px; /* 属性提示注释 */
  5. background-position:center center; /* 属性提示注释 */
  6. background-repeat:no-repeat; /* 属性提示注释 */
  7. /*background-repeat: repeat;备用声明注释 */
  8. }

1.1单行注释

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

  1. /* Comment Text */
  2. .jdc {}
  3. /* Comment Text */
  4. .jdc {}

模块注释

注释内容第一个字符和最后一个字符都是一个空格字符,

  1. /* 与 模块信息描述占一行,
  2. 多个横线分隔符 - 与 */ 占一行,
  3. 行与行之间相隔两行。
  4. /* Module A
  5. ---------------------------------------------------------------- */
  6. .mod_a {}
  7. /* Module B
  8. ---------------------------------------------------------------- */
  9. .mod_b {}

1.3文件注释

页面名称、作者、创建日期等信息

@charset “UTF-8”;

  1. /**
  2. * @desc File Info
  3. * @author Author Name
  4. * @date 2015-10-10
  5. */