jsdoc

一、javascript注释规范

　　我们在编写javascript文件的时候，一般会添加一些注释。例如一些文件、类、方法和属性都应该用合适的标记和类型进行注释。这里不但方便我们的阅读，也能养成一个好的习惯。更大的好处是，我们可以根据这些注释生成帮助文档。

二、JSDoc 3

　　JSDoc 3是一个生成为Javascript生成API文档的工具。下载地址为：https://github.com/jsdoc3/jsdoc 。使用JSDoc 3 我们需要有Node.js环境。Node.js安装好之后，我们可以通过如下命令，可以按照最好的alpha版本：

三、配置要生成的文档

1、　此时我们可以配置C:/Users/user/node_modules/jsdoc目录下的conf.json.EXAMPLE文件。为这个文件source李联盟添加一行如下图所示：

把需要生成文档的js和config全放在E:\jsDoc\node_modules\.bin 下。在cmd里面运行jsdoc，即可生成API文档。

2、 指定配置文件

要自定义JSDoc的行为，可以使用JSON格式的配置文件格式化JSDoc, 使用-c选项指定配置文件，例如： jsdoc -c 配置文件路径。

配置文件不一定要叫config.json或者config.json.EXAMPLE 可以是任意名字，如，11.json是我的配置文件，可以如下。 执行后，会把文档输入到out文件夹（默认）下。 当然，也可以自己指定文件夹