Schreiben Sie JavaDocs für externe Bibliothek

Meine Situation ist ich habe eine externe kompilierte Bibliothek (jar) von einem Drittanbieter ohne JavaDocs. Während ich mich entwickle, möchte ich die Klassen und Methoden dokumentieren, indem ich die sehr begrenzte Dokumentation, die ich von der Website der dritten Partei bekomme, teste und benutze.Schreiben Sie JavaDocs für externe Bibliothek

Mein Endziel ist eine JavaDoc-Dokumentation, die ich in IntelliJ für die Code-Hinting und Dokumentation Lookup verwenden kann?

Meine Frage ist also, ist es möglich, JavaDocs in eine bereits kompilierte JAR-Datei zu schreiben, die ich importieren kann? Vielleicht mit einem Werkzeug, das dies unterstützt.

Quelle

2017-06-26 JensV

Ja ist es. Alles, was Sie tun müssen, ist, die Klassen- und Interface-, Methoden- und Variablendefinitionen ohne Code auszugeben, als ob alle Methoden abstrakt wären, und dann Javadoc-Kommentare für diese schreiben. So produzierte Sun das Javadoc über einen komplett separaten Quellbaum, der von den technischen Redakteuren und Editoren (hi Doug!) Gesteuert wurde, mit einem Merge-Prozess, der spät im Build-Prozess für die Freigabe des Quellcodes war.

Quelle

2017-06-26 10:54:39 EJP

Können Sie ein schnelles Codebeispiel zeigen? Es würde helfen, Ihre Antwort klarer zu machen. – byxor

Schreiben Sie die Methoden einfach so aus, als ob sie abstrakt wären, ohne das Schlüsselwort "abstract", d. H. Nur ein Semikolon anstelle des Körpers der Methode. Sie können das nicht kompilieren, aber Sie können es Javadoc. – EJP

Das hat funktioniert! Ich habe dafür ein separates Projekt erstellt und genau das getan, was Sie gesagt haben. Das Projekt wird voller Fehler sein, aber der JavaDoc-Generator hat keine Probleme damit. In meinem Hauptprojekt habe ich die Dokumente angehängt und es hat wie ein Zauber funktioniert. Vielen Dank :) – JensV

Schreiben Sie JavaDocs für externe Bibliothek

Antwort

Verwandte Themen