如何为我没有源代码的.jar文件中的类生成JavaDoc文档?

时间:2010-06-25 03:20:59

标签: java javadoc

我想为我的Java 1.6应用程序中的所有类生成API。 它应该看起来像常规的Java 1.5 API文档。

我没有源代码。我在jar文件中有类文件。

4 个答案:

答案 0 :(得分:16)

你不能从类文件的jar中生成Javadoc,甚至不能生成基本的Javadoc。您只能从源文件生成Javadoc,因为这是Javadoc所在的位置。

答案 1 :(得分:4)

我没有使用它,但是这个开源项目声称从java类或jar文件创建文档:

http://classdoc.sourceforge.net/

答案 2 :(得分:2)

您可以在类路径中的任何类上使用javap命令。这不会产生Javadoc文件,但它允许您查看该类提供的内容。

...防爆

javap java.lang.String生成以下输出

public final class java.lang.String implements java.io.Serializable, java.lang.Comparable<java.lang.String>, java.lang.CharSequence {
  public static final java.util.Comparator<java.lang.String> CASE_INSENSITIVE_ORDER;
  public java.lang.String();
  public java.lang.String(java.lang.String);
  public java.lang.String(char[]);
  public java.lang.String(char[], int, int);

...在一堆构造函数之后还有其他方法......

  public int length();
  public boolean isEmpty();
  public char charAt(int);
  public int codePointAt(int);

你可以让它向你展示其他东西,但这可能是最有帮助的。

不完全是你想要的,但如果你只有一个带有一堆课程的jar,这可能是你最好的选择。

答案 3 :(得分:1)

谁在改变我的问题?我没有源代码。我在jar文件中有类文件。 Purushotham 47分钟前

您没有任何源文件?那么你可能运气不好。可能有一些隐藏在Eclipse巨大数据库中的模糊插件可以从类文件中执行,但即便如此,您只会获得方法签名,而不是任何注释。


但是,如果这是您编写的项目,则可以在IDE中生成JavaDoc。对于Eclipse do Project&gt;生成JavaDoc。在NetBeans中,右键单击您的项目,然后选择Generate JavaDoc。

如果您想要包含您的依赖项,那么这是一个非常糟糕的主意。始终链接到您的依赖项的JavaDocs,永远不要将它包含在您的JavaDocs中。如果不是因为看不到来自Large Overly Framework X的大量课程而失去理智,那只是为了让它们分开。如果我想在你的项目中阅读JavaDoc,我想只在你的项目上阅读它,而不是在slf4j上。