Écrire JavaDocs pour la bibliothèque externe

Question

Ma situation est que j'ai une bibliothèque compilée externe (jar) d'un tiers sans JavaDocs. Comme je suis en train de développer je veux documenter les classes et les méthodes en testant et en utilisant la documentation très limitée que je reçois du site Web de la 3ème partie.

Mon but final est d'avoir une documentation JavaDoc que je pourrai utiliser dans IntelliJ pour la recherche de Code-Hinting et de documentation. Donc, ma question est, est-il possible d'écrire JavaDocs dans un fichier jar déjà compilé que je pourrai importer? Peut-être en utilisant un outil qui aide cela.

Answer 1

Oui c'est. Tout ce que vous avez à faire est d'écrire la classe et l'interface et la méthode et les définitions de variables, sans aucun code, comme si toutes les méthodes étaient abstraites, puis écrire des commentaires Javadoc pour ceux-ci. C'est en fait la façon dont Sun a produit le Javadoc, via un arbre source complètement séparé contrôlé par les rédacteurs techniques et les éditeurs (salut Doug!), Avec un processus de fusion tard dans le processus de construction pour libérer le code source.