Ich baue Gläser, wo ich sie ohne Quellen verpacken möchte, aber ich möchte das Javadoc für Entwickler in Eclipse kommen.Wie bekomme ich Eclipse, um das Javadoc aus meinen Klassen zu zeigen, ohne Quellen in das Glas
Was ist Ihr Build-Prozess? Der Maven-Release-Prozess erzeugt tatsächlich 3 Gläser, von denen eines die kompilierten Klassen enthält, eines mit Quellen und eines mit Javadocs. Sie sollten in der Lage sein, das POM so anzupassen, dass die Verteilung des Quelljars verhindert wird, und jeder, der Maven verwendet, um Abhängigkeiten zu verwalten, erhält automatisch das Javadoc, wenn sie eine Abhängigkeit von Ihrem jar deklarieren (und Javadoc-Download im Eclipse Maven Plugin aktiviert haben).
Javadocs sind Teil des Quellcodes, da jede kompilierte Klasse keinen Kommentar enthält - Javadocs sind Kommentare.
Mit anderen Worten, Sie können nicht.
Aber javadoc erzeugt HTML, auf das ich manuell mit eclipse entweder auf einen Ordner oder ein jar zeigen kann. Ich möchte das nur in meine verteilten Jars aufnehmen können, so dass Eclipse es findet. – Tom
Das ist richtig, aber Sie werden nicht in der Lage sein, das _inside_ Ihrer JAR zu setzen. Wie auch immer, alle Lösungen, die so funktionieren, wie Sie es beschreiben, stellen eine externe Quell-Zip-Datei bereit, die _both_ sources und javadoc enthält. Wenn Sie möchten, können Sie Methodenquellen entfernen und eine leere Shell erstellen, die als Javadoc-Quelle dient. – Seb
Die Benutzer Ihrer JAR können einen Javadoc-Speicherort (URL, Datei oder Pfad in einem Archiv) in den Java-Buildpfad-Eigenschaften des Java-Projekts zuordnen, in dem die JAR verwendet wird.
Ich bin nicht sicher, wie gut dies mit dem Javadoc in der gleichen JAR wie die Binaries funktionieren würde (nie zuvor gesehen), aber in der Theorie sollte es funktionieren.
Apache Ant javadoc Aufgabe wird API HTML erzeugen. Normalerweise würden Sie dies dann als Zip-Datei zusammen mit Ihren Gläsern verteilen.
JIDE have a tool (kostet $ 25), die über Ihren Quellcode laufen und alle Methodenkörper entfernen, das javadoc zurücklassen und eine ZIP-Datei erzeugen. Sie können diese ZIP dann als Quell-ZIP verteilen, und Ihre IDE kann die Javadocs lesen, aber natürlich wurde Ihre gesamte Logik entfernt, so dass Sie Ihre Closed-Source-Eigenschaft beibehalten können. Alle privaten Mitglieder und Methoden sind nicht in der ZIP-Datei enthalten.
Es hat auch den zusätzlichen Bonus von für intellisense Methode Parameternamen beibehalten, so dass die folgende Methode
public void foo(String text, Integer index) {
}
zeigen foo (String Text, Integer-Index), wenn Sie die automatische Vervollständigung, statt foo (String arg1, Integer arg2) so können Sie darauf hinweisen, was die Parameter sein sollten.
Leider verwenden wir eher ant als maven: o ( – Tom
) Sie können die maven build-Tasks verwenden, um javadoc und or source jars zu erzeugen, sogar von Ant. Da Sie ant für den Aufbau und vermutlich das Abhängigkeitsmanagement verwenden brauche nur einen minimalen Pom, damit Maven funktioniert, und gib das Quellverzeichnis an, aus dem das Javadoc generiert werden soll. – Jherico
Dies ist, was ich am Ende gemacht habe, nun, ich baue die src und doc jars durch ant not maven. – Tom