Générateur de template Javadoc

Question

J'ai une base de code importante sans Javadoc, et je veux lancer un programme pour écrire un squelette avec les informations de base Javadoc (par exemple, pour le paramètre de chaque méthode écrire @param ...), donc je dois juste Remplissez les espaces laissés.

Quelqu'un sait-il une bonne solution pour cela?

Edit:

JAutodoc est ce que je cherchais. Il a des tâches Ant, un plugin Eclipse et utilise Velocity pour la définition du template.

Answer 1

Le plugin pour eclipse JAutodoc fait exactement ce dont vous avez besoin, mais avec une granularité de package:

clic droit sur un package, sélectionnez « Ajouter javadoc pour les membres ... » et le squelette sera ajouté.

Il existe de nombreuses options intéressantes: des modèles pour javadoc, en ajoutant un TODO dans l'en-tête de chaque fichier en disant: « javadoc modèle, doit être rempli ... », etc.

Answer 2

Si vous faites un clic droit dans la source d'un fichier dans Eclipse, il a une option de génération de Javadoc dans le menu source.

Answer 3

Vous pouvez configurer Eclipse pour afficher les avertissements pour les choses qui manquent de javadoc, ou qui ont javadoc qui n'a pas toutes les informations, ou qui a des informations erronées. Il peut également insérer des modèles pour que vous remplissiez.

Pas tout à fait l'outil que vous avez demandé, mais probablement mieux parce que vous ne serez pas finir avec des squelettes vides sur les méthodes que vous avez manqué.

Vous pouvez y parvenir en enquêtant et en éditant la page de préférence au-delà du chemin Fenêtre> Préférences> Java> Compiler> Javadoc pour votre espace de travail. La capture d'écran de cette page de préférences est ci-dessous:

Pour plus d'informations sur les éléments de cet écran s'il vous plaît suivez le lien ci-dessous:

Java Compiler Javadoc Preferences Help

Answer 4

Je pense que l'auto-génération Javadoc vide est un anti-pattern et devrait être découragé; il donne au code l'apparence d'être documenté, mais ajoute simplement du bruit à la base de code. Je recommande à la place de configurer votre éditeur de code pour vous aider, par méthode et par classe, à l'utiliser lorsque vous écrivez réellement le javadoc (un commentateur a fait référence à la fonctionnalité d'Eclipse qui fait cela).

Answer 5

Vous pouvez également placer votre curseur sur la ligne ci-dessus une méthode que vous souhaitez JavaDoc, puis tapez:

/** 

et appuyez sur Entrée. Cela va générer votre stub JavaDoc.

Answer 6

Sélectionnez la méthode que vous voulez ajouter Javadoc et alt + Maj +j, crée automatiquement le javadoc.

Exemple:

/** 
    * @param currDate 
    * @param index 
    * @return 
    */ 
    public static String getAtoBinary(String currDate, int index){ 
     String HourA = "0"; 
     try{ 
      String[] mydate = currDate.split("/"); 
      HourA = mydate[index].substring(1, 2); 
     }catch(Exception e){ 
      Log.e(TAG, e.getMessage()); 
     } 
     return HourA; 
    }