Est-il possible de générer automatiquement TOUS les commentaires Javadoc dans Eclipse?
Je sais que vous pouvez appuyer sur shift + alt + j pour insérer un modèle de commentaire approprié pour le bloc de code actuel, mais existe-t-il un moyen de laisser Eclipse devenir fou et faire un projet entier comme celui-ci?
Pour un projet entier, peut-être pas, mais vous pouvez au moins:
- accédez à la vue Explorateur de packages
- développez la classe sur laquelle vous souhaitez générer des commentaires (ouvrez chaque méthode)
- sélectionner tous les éléments ouverts de la classe dans cette arborescence de l'explorateur de packages
- alt+shift+J et voilà: les commentaires générés sur la classe, et chaque méthode
La seule raison pour laquelle ce n'est pas pratique pour tout le projet est:
- vous devez ouvrir chaque classe sur laquelle vous souhaitez générer des commentaires
- une fois qu'un premier ensemble de méthodes a été commenté, vous devez toujours répéter le processus si vous avez écrit de nouvelles méthodes.
Cela étant dit, une autre approche est décrite dans l'article "Le problème des Javadocs incomplets" du 30 mars 2010, préconisant pour un vue Javadoc étendue.
La vue Javadoc étendue est essentiellement un agrégateur de différentes sources d'informations pour un élément de code unique comme une classe, une méthode, un champ ou un paramètre. Il est conçu pour remplacer le Javadoc Eclipse existant.
La partie intéressante est fournie avec les autres onglets de la vue: Directives de sous-classement et modèles de sous-classement .
Ces onglets contiennent des informations minées sur la façon dont les développeurs ont généralement étendu l'élément de code sélectionné.
- Onglet de sous-classement:
les directives de sous-classement sont des généralisations d'observations fréquemment faites dans un exemple de code comme "Les sous-classes de Wizard remplacent toujours sa méthode
addPages()" ou "ReimplementorsofDialog.createContents()peut appeler sa super implémentation ".
- Onglet Modèles de sous-classement
Les modèles de sous-classe essaient de regrouper les extensions observées d'une classe de base en modèles d'extension typiques, c'est-à-dire qu'ils regroupent les sous-classes par similitude pour trouver des modèles dans les données.
Je cherchais également un outil javadoc automatique pour Eclipse et j'en ai trouvé un appelé JAutodoc .
Cet outil génère assez bien des commentaires et ne nécessite que des modifications mineures manuellement à certains endroits (si vous en avez besoin). À mon avis, cet outil peut économiser environ 75% du temps passé à rédiger des commentaires.
Vous pouvez visiter ici pour des instructions détaillées sur le téléchargement et l'intégration avec Eclipse.
Il y a aussi ce plugin, que je n'ai pas encore essayé, mais qui semble prometteur: JAutoDoc