44 votes

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 de faire un projet entier comme celui-ci?

71voto

VonC Points 414372

Pour tout projet, peut être pas, mais vous pouvez au moins:

  • aller à la Vue Package Explorer
  • étendre la classe que vous souhaitez générer des commentaires sur (ouvrir chaque méthode)
  • sélectionnez toutes les ouvert éléments dans la classe à partir de ce Paquet Arborescence de l'Explorateur d'
  • alt+maj+J et voilà: les commentaires générés sur la classe, et chaque méthode

La seule raison pour laquelle il n'est pas pratique pour le projet est:

  • vous devez ouvrir chaque classe que vous souhaitez générer des commentaires sur
  • une fois un premier ensemble de méthodes ont été commentée, vous avez encore besoin de 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 de l'insuffisance des Javadoc" du 30 Mars 2010, plaidoyer pour une étendue Javadoc vue.

La prolongation de la Javadoc point de Vue est essentiellement un agrégateur de différentes sources d'informations pour un seul élément de code comme une classe, une méthode, un champ ou d'un paramètre. Il est conçu comme un remplacement de l'existante d'Eclipse Javadoc.

alt text

La partie intéressante est livré avec les autres onglets de la vue: - Classement des Directives et des Modèles de sous-classement.
Ces onglets contiennent des extraits d'informations sur la façon dont les développeurs généralement étendu le code sélectionné l'élément.

  • Sous-classement de l'onglet:

sous-classement directives sont des généralisations de fréquentes observations dans l'exemple de code comme "sous-classes de l'Assistant de toujours remplacer sa méthode addPages()" ou "Reimplementors de Dialog.createContents() peut appeler ses super mise en œuvre".

http://code-recommenders.googlecode.com/svn/wiki/images/extdoc/tab-subclassing-directives-Wizard.png

http://code-recommenders.googlecode.com/svn/wiki/images/extdoc/tab-subclassing-directives-Wizard-addPages.png

  • Sous-Classement Onglet Motifs

Sous-classement des modèles d'essayer de groupe a observé des extensions d'une classe de base dans typique de l'extension des modèles, c'est à dire, ils cluster de sous-classes de similitude de trouver des modèles dans les données.

http://code-recommenders.googlecode.com/svn/wiki/images/extdoc/tab-subclassing-patterns-ViewerComparator.png

23voto

Arun Points 91

J'étais également à la recherche d'une auto javadoc outil pour eclipse et a trouvé un appelé JAutodoc.

Cet outil génère des commentaires assez bien et ne nécessite que des modifications mineures manuellement dans certains endroits (si vous avez besoin). À mon avis, cet outil peut enregistrer environ 75% du temps passé dans l'écriture des commentaires.

Vous pouvez visiter ici pour obtenir des instructions détaillées sur le téléchargement et l'intégration avec eclipse.

6voto

StormPooper Points 182

Il y a aussi ce plugin, que je n'ai pas encore essayé, mais qui semble prometteur: JAutoDoc

Prograide.com

Prograide est une communauté de développeurs qui cherche à élargir la connaissance de la programmation au-delà de l'anglais.
Pour cela nous avons les plus grands doutes résolus en français et vous pouvez aussi poser vos propres questions ou résoudre celles des autres.

Powered by:

X