Ich möchte die API für alle Klassen generieren, die in meiner Java 1.6-Anwendung vorhanden sind. Es sollte wie reguläre Java 1.5-API-Dokumentation aussehen.Wie generiere ich JavaDoc-Dokumentation für Klassen in einer JAR-Datei, für die ich keinen Quellcode habe?
Ich habe den Quellcode nicht. Ich habe Klassendateien in einer JAR-Datei.
Sie können Javadoc nicht aus Gläsern von Klassendateien erzeugen, nicht einmal rudimentäre Javadoc. Sie können Javadoc nur aus Quelldateien generieren, da Javadoc dort lebt.
Wer ändert meine Frage? Ich habe den Quellcode nicht. Ich habe Klassendateien in einer JAR-Datei. Purushotham Vor 47 Minuten
Sie haben keine Quelldateien? Na dann hast du wahrscheinlich kein Glück. Es könnte ein obskures Plugin in der riesigen Datenbank von Eclipse vergraben sein, das es aus Klassendateien tun kann, aber selbst dann werden Sie nur Methodensignaturen bekommen, keine Kommentare.
Wenn dies jedoch Ihr Projekt ist, das Sie geschrieben haben, können Sie JavaDoc in Ihrer IDE generieren. Für Eclipse führen Sie Project> Generate JavaDoc aus. Klicken Sie in NetBeans mit der rechten Maustaste auf Ihr Projekt und wählen Sie JavaDoc generieren aus.
Wenn Sie Ihre Abhängigkeiten einschließen möchten, dann ist das eine sehr schlechte Idee. Verknüpfen Sie immer die JavaDocs Ihrer Abhängigkeiten, und schließen Sie sie niemals in Ihre JavaDocs ein. Wenn Sie Ihre geistige Gesundheit nicht verlieren wollen, wenn Sie eine große Wand von Klassen von Large Overly Framework X sehen, ist es nur, sie getrennt zu halten. Wenn ich das JavaDoc in Ihrem Projekt lesen möchte, möchte ich es nur auf Ihrem Projekt lesen, nicht auf slf4j.
Ich habe es nicht benutzt, aber das Open-Source-Projekt behauptet docs von Java-Klasse oder JAR-Dateien zu erstellen:
aber das ist nur für Java 1.3, können Sie jede andere Option vorschlagen, die für Java unterstützt 1.6, 1.7,1.8 – Pratswinz
Hey! Die einzige andere Lösung, die ich gesehen habe (aber nicht benutzt habe) [ist möglicherweise diese] (http://stackoverflow.com/q/24500845/26510) –
Sie den javap Befehl für jede Klasse kann in Ihrem Classpath. Dies erzeugt keine Javadoc-Dateien, aber Sie können sehen, was die Klasse bietet.
Ex ...
javap java.lang.String erzeugt die folgende Ausgabe
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);
... und nach einer Reihe von Konstrukteuren gibt es andere Methoden ...
public int length();
public boolean isEmpty();
public char charAt(int);
public int codePointAt(int);
Und Sie können habe es dir auch andere Dinge zeigen, aber das ist wahrscheinlich am hilfreichsten.
Nicht genau das, was Sie suchen, aber wenn Sie nur ein Glas mit einer Reihe von Klassen haben, könnte dies die beste Option sein.
* "... selbst dann werden Sie nur Methodensignaturen erhalten" *, und die Signaturen werden wahrscheinlich nicht einmal die ursprünglichen Argumentnamen enthalten! –
Ja, natürlich. Aber wenn das alles ist, was du hast, ist es besser als nichts. – fool4jesus