为编译的类生成html文档

时间:2010-02-22 08:14:09

标签: java documentation

我在jar中有一个java编译库。我在源代码中编写了文档。还有一个生成jar的工具,它只包含目标项目所需的那些类。我有大项目使用这个jar,只有那些类应该进入目标项目。 现在问题 我想提供类的文档。是否可以从编译的类生成文档?

3 个答案:

答案 0 :(得分:2)

没有。文档(javadoc)是从源(.java)文件生成的。编译后,所有注释/ javadoc都会丢失。

该库的用户只能将其IDE的自动完成功能用作某种文档。

我看不到你的脚本,但我认为你可以将相同的逻辑应用于生成jars的生成javadoc。

答案 1 :(得分:1)

没有简单的方法可以做你想做的事,但你可以尝试以下方法:

  1. 提取JAR中所有.class个文件的名称,过滤掉名称中包含$的文件,并将其余文件映射到原始.java文件名。

  2. 创建一个临时目录树,其中包含上面选择的所有.java个文件的副本。

  3. 使用about树作为源路径运行javadoc命令。

  4. 如果您没有太多文件,则可以跳过创建目录树的步骤并运行javadoc命令,并将所有.java文件名作为命令参数。

    无论哪种方式,你都会有一些非平凡的脚本......或等效的Java ......来实现。

答案 2 :(得分:0)

我想你应该分别过滤目标项目所需类的注释,并与正在创建的子jar结合使用。