代码之家  ›  专栏  ›  技术社区  ›  Ravisha

为已编译类生成HTML文档

  •  1
  • Ravisha  · 技术社区  · 15 年前

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

    3 回复  |  直到 15 年前
        1
  •  1
  •   Stephen C    15 年前

    没有简单的方法可以满足您的需求,但您可以尝试以下方法:

    1. 提取所有人的姓名 .class 你的jar中的文件,过滤掉任何 $ 并将其余部分映射到原始 .java 文件名。

    2. 创建一个临时目录树,其中包含 爪哇 上面选择的文件。

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

    如果没有太多文件,可以跳过创建目录树的步骤并运行 贾瓦多克 命令 爪哇 文件名作为命令参数。

    不管怎样,您都会有一些非常重要的脚本…或等效Java…实施。

        2
  •  2
  •   Bozho    15 年前

    不,文档(JavaDoc)是从源代码(.java)文件生成的。编译后,所有注释/javadocs都将丢失。

    库的用户只能使用其IDES的自动完成功能作为某种文档。

    我看不到您的脚本,但我认为您可以将相同的逻辑应用到javadoc的生成中,就像生成jar的逻辑一样。

        3
  •  0
  •   NileshChauhan    15 年前

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