JsDoc应用与配置

1. JsDoc相关网址

    google code网址： http://code.google.com/p/jsdoc-toolkit/

    github网址： https://github.com/jsdoc3

 

2. API生成模板，codeview，在 附件中有。

 

3. API生成功具，jsdoc-toolkit，在 附件中有。

 

4. 相应的配置文件可以参考：conf/smaple.conf

    其中几个要点：

    // 源文件

    _: ['  ', '  ']          // 其中每一个文件用一个单引号括起来，可以支持多个文件同时生成。

    d: xxxx              //  该参数配置api文件生成后，存放的目录。

    t: xxxxx             //  该参数配置在API生成时所采用的模板

 

5. 执行命令生成，在附件中，我写了一个BAT文件。

    java -jar jsrun.jar app\run.js -c=conf\sample.conf

     如果你的jsdoc出现编码问题，中文是乱码的话可以使用-e参数来制定编码，当然编码要和你的js文件格式一致，如果你的js是utf-8格式，则使用：-e=utf-8。如：java -jar jsrun.jar app\run.js -e=gb2312 -c=conf\sample.conf

 

6. 注释编写手册可参考： http://usejsdoc.org/

 

7.

8. 生成后的效果：

    

 

附件列表