论坛首页 Java企业应用论坛

Jsdocx(文档自动化生成工具)正式发布!

浏览 6877 次
精华帖 (0) :: 良好帖 (0) :: 新手帖 (0) :: 隐藏帖 (0)
作者 正文
   发表时间:2011-12-20   最后修改:2011-12-20
这是一款用java写的文档生成工具。可以自动扫描JS源代码,抽取所有类的方法与属性生成完整的项目API文档。

示例代码生成的HTML文档可以看这里:http://jsdocx.sourceforge.net/example/sanguo/js/jsdocx/index.html
Jsdocx的项目首页:http://jsdocx.sourceforge.net/
Jsdocx的注释规范文档:http://jsdocx.sourceforge.net/Jsdocx_Annotation_Specification.html

你可以下载jar。
在命令行中执行:
java -cp org.dragonfly.jsdocx-<version>.jar org.dragonfly.jsdocx.JsdocCreator -Souredir=<js source's directory>

Arguments:
-Charset=<charset>: the generating html document's charset
-Souredir=<directoryPath>: the javascript source's directory
-Docdir=<directoryPath>: the generating html document's directory
-Clean: clean the html document's directory before generating

或者在Java代码中执行:
JsdocConfig config = new JsdocConfig();
config.setSourceDir("the javascript source's directory");
new JsdocCreator(config).generate();
   发表时间:2011-12-20  
做这个的动机是啥,我看demo里的展示和javadoc生成的没啥太多区别么
0 请登录后投票
   发表时间:2011-12-21  
试用了下 很不错

这款工具会火

0 请登录后投票
   发表时间:2011-12-21  
貌似很不错先去收藏一下吧,生成的文档好像没有伸缩功能.
0 请登录后投票
   发表时间:2011-12-21  
跟jsdoc-toolkit这个感觉一样呀。
0 请登录后投票
   发表时间:2011-12-21  
D:\jsdocx>java -cp jsdocx.jar org.dragonfly.jsdocx.JsdocCreator -Souredir=D:\jsdocx\
Exception in thread "main" java.lang.NullPointerException
        at org.dragonfly.jsdocx.output.ProjectDocumentWriter.write(ProjectDocume
ntWriter.java:119)
        at org.dragonfly.jsdocx.JsdocCreator.generate(JsdocCreator.java:138)
        at org.dragonfly.jsdocx.JsdocCreator.main(JsdocCreator.java:159)
0 请登录后投票
   发表时间:2011-12-21  
挺好的,我喜欢这样的工具
0 请登录后投票
   发表时间:2011-12-22  
agapple 写道
做这个的动机是啥,我看demo里的展示和javadoc生成的没啥太多区别么

这不就是目的吗
0 请登录后投票
   发表时间:2011-12-23  
我觉得这个工具的目的挺好的,java可以生成很不错的javadoc,js如果也能生成类似的doc,可以减少沟通的阻碍,同事也可以规范js的编码。
0 请登录后投票
   发表时间:2011-12-23  
我想问一下,Jsdocx的注释规范文中的注释规范是自定义的还是根据标准?能否扩展?
0 请登录后投票
论坛首页 Java企业应用版

跳转论坛:
Global site tag (gtag.js) - Google Analytics