Как создать документацию JavaDoc для классов в файле .jar, для которого у меня нет исходного кода? - PullRequest
Новая
       22

Как создать документацию JavaDoc для классов в файле .jar, для которого у меня нет исходного кода?

16 голосов
/ 25 июня 2010

Я хочу сгенерировать API для всех классов, которые есть в моем приложении Java 1.6.Он должен выглядеть как обычная документация по API Java 1.5.

У меня нет исходного кода.У меня есть файлы классов в jar-файле.

Ответы [ 4 ]

16 голосов
/ 25 июня 2010

Вы не можете создавать Javadoc из файлов с файлами классов, даже из элементарных Javadoc.Вы можете генерировать Javadoc только из исходных файлов, потому что именно там живет Javadoc.

4 голосов
/ 04 июля 2013

Я не использовал его, но этот проект с открытым исходным кодом претендует на создание документов из java-классов или jar-файлов:

http://classdoc.sourceforge.net/

2 голосов
/ 14 января 2015

Вы можете использовать команду javap для любого класса в вашем classpath. Это не приведет к созданию файлов Javadoc, но позволит вам увидеть, что предоставляет класс.

Ex ...

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);

И он может показывать вам и другие вещи, но это, вероятно, наиболее полезно.

Не совсем то, что вы ищете, но если у вас просто баночка с кучей классов, это может быть вашим лучшим вариантом.

1 голос
/ 25 июня 2010

Кто меняет мой вопрос? У меня нет исходного кода. У меня есть файлы классов в JAR-файле. Пурушотам 47 минут назад

У вас нет исходных файлов? Ну, тогда тебе, вероятно, не повезло. В огромной базе данных Eclipse может быть скрыт какой-то непонятный плагин, который может делать это из файлов классов, но даже тогда вы получите только сигнатуры методов, а не комментарии.

Однако, если вы написали этот проект, вы можете сгенерировать JavaDoc в своей IDE. Для Eclipse выполните Project> Generate JavaDoc. В NetBeans щелкните правой кнопкой мыши свой проект и выберите «Создать JavaDoc».

Если вы хотите включить свои зависимости, тогда это очень плохая идея. Всегда ссылайтесь на JavaDocs ваших зависимостей, никогда не включайте его в свой. Если не потерять здравомыслие, увидев огромную стену классов из Large Overly Framework X, то просто держите их отдельно. Если я хочу прочитать JavaDoc в вашем проекте, я хочу прочитать его только в вашем проекте, а не в slf4j.

...