9 代码注释

代码是由人编写并维护的。请确保你的代码能够自描述、注释良好并且易于他人理解。好的代码注释能够传达上下文关系和代码目的。不要简单地重申组件或 class 名称。

9.1 单行注释

【强制】 星号与内容之间必须保留一个空格；

示例：

  1. /* 新闻中心表格隔行变色 */

9.2 多行注释

【强制】 星号要一列对齐，星号与内容之间必须保留一个空格；

示例：

  1. /**
  2.  * Sometimes you need to include optional context for the entire component. Do that up here if it's important enough.
  3.  */

9.3 文件注释

【强制】 文件顶部必须包含文件注释，用 @file 标识文件说明。星号要一列对齐，星号与内容之间必须保留一个空格，标识符冒号与内容之间必须保留一个空格；

  1. /**
  2.  * @file: 文件概要描述
  3.  * @author: author-name(mail-name@domain.com)
  4.  *          author-name2(mail-name2@domain.com)
  5.  * @update: 2015-04-29 00:02:45
  6.  */
  • @update为可选项，建议每次改动都更新一下；
  • 当该业务项目主要由固定的一个或多个人负责时，需要添加@author标识，一方面是尊重劳动成果，另一方面方便在需要时快速定位责任人；

[⬆]

参考资料：

  1. bootcss编码规范
  2. 豆瓣CSS Code Guideline
  3. spec css style guide