Peut-on créer automatiquement des balises javadoc pour un projet Eclipse entier?

Question

je sais que l'on peut utiliser ' J' pour créer des étiquettes pour un élément de code unique (méthode de classe par exemple).

Mais est-il un moyen de créer automatiquement ces balises pour chaque classe dans l'ensemble du projet? Ou même juste au niveau package ou une classe?

Answer 1

Avez-vous regardé JAutodoc ?

Answer 2

Pas que je sache.

Qu'est-ce que ce serait bon de toute façon? AutoGénéré commentaires Javadoc sont pires qu'inutiles; Je préfère ne pas avoir les encombrent mon code, et Javadoc fournir autant d'informations même sans présent commentaire.

Answer 3

automatique généré JavaDoc est une douleur, parce que les autres ne maintenant ce que la méthode devrait faire et vous aussi sans le savoir, quand vous regardez la classe un an plus tard.

S'il vous plaît commenter vos méthodes par vous-même ou ne pas commenter la méthode.

Mon entreprise utilise checkstyle pour forcer les employeurs à ajouter javadoc. Certains employeurs détestent pour commenter leurs méthodes et il suffit de taper les commentaires Sensless. Il serait préférable que leur est pas de commentaire qu'un inutile.

Avec checkstyle vous pouvez trouver toutes les méthodes non documentées, de les documenter dans un format bien.

Qu'est-ce qui vous aidera à documenter une méthode d'initialisation comme

  

"init doit être appelée avant tout   autre méthode et initialise la classe   ActionDummy "

il est préférable de dire ce qui se fait exactement

  

Inizializes l'état par défaut du   fournisseur d'action. Certaines variables d'état peuvent être   overriden par l'auditeur quand ....