by 陶涛

• 简介：在代码里面按照规范写了注释之后，jsdoc工具可以自动生成技术文档。

• 参考文档地址: http://www.dba.cn/book/jsdoc/

• 注释可参考文件:

  src/model/cell.js
  

• 安装jsdoc:

  # 在全局安装jsdoc
  npm install -g jsdoc
  

• 具体使用方式:

  

  @constructor 明确一个函数是某个类的构造函数。
  @param 参数注释
  @return 返回值注释
  @example 示例注释
  @overview 对当前代码文件的描述。
  @copyright 代码的版权信息。
  @author []代码的作者信息。
  @version 当前代码的版本。
  

• 当前文件完成注释后，可以使用：

  jsdoc -d docs 路径 例如: jsdoc -d docs src/model/cell.js

  就会docs目录中生成一系列文件