生成 JavaScript API 文档

开发中，JavaScript插件需要提供可读性高的插件使用文档，手动编写文档存在易出错、效率低等问题。因此，引入JSDoc生成JS API，介绍插件使用规范，提升开发效率。

1.  使用 maven 构建工具时，maven 自带 JSdoc jar包，可直接使用;

<!-- 配置JSDoc -->

<plugin>

<groupId>nl.windgazer</groupId>

<artifactId>jsdoctk-plugin</artifactId>

<version>2.3.2</version>

<configuration>

<srcDir>${basedir}/</srcDir>

<directory>${basedir}/src/main/webapp/demo/JSDoc</directory>

<recurse>0</recurse>

</configuration>

<executions>

<execution>

<phase>install</phase>

<goals>

<goal>jsdoc</goal>

</goals>

</execution>

</executions>

</plugin>

 

2.  没有使用 maven ，需要使用 JsDoc Toolkit 辅助工具；

下载地址：http://code.google.com/p/jsdoc-toolkit/

使用中注意事项：

1. jsdoc-toolkit 中存放的是JAR和JS，不用管；

2. out 文件夹是.bat 执行后生成的，symbols 文件夹中是生成的单个类的文档，不用管。file.html 和index.html 就是生成文档的目录和索引，用这个来查看；

3. test 文件夹中添加JS文件，如果放的是文件夹，需要修改.bat 中的路径。试了下，JS和文件夹不能同级存放；

4. 每次修改test 文件夹中的JS，需要执行.bat，如果有警告或者报错，一般都是JS中的注释不规范引起的；

5.  bat文件配置 java -jar jsdoc-toolkit/jsrun.jar jsdoc-toolkit/app/run.js -a -e=utf-8 -t=jsdoc-toolkit/templates/jsdoc test/*.js  文件路径可配置；

6.  文档风格样式可自定义CSS设置；

转载于:https://www.cnblogs.com/bettry/p/7299856.html