Générateur de modèles Javadoc [fermé]

Question

J'ai une grande base de code sans Javadoc et je souhaite exécuter un programme pour écrire un squelette avec les informations de base de Javadoc (par exemple, pour le paramètre de chaque méthode, écrivez @param...), il me suffit donc de combler les lacunes restantes.

Quelqu'un connaît-il une bonne solution pour cela ?

Modifier:

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

Answer 1

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

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

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

Answer 2

Je pense que la génération automatique de Javadoc vide est un anti-modèle et devrait être découragée ;cela donne au code l'apparence d'être documenté, mais ajoute simplement du bruit à la base de code.

Je vous recommanderais plutôt de configurer votre éditeur de code pour qu'il vous aide par méthode et par classe à utiliser lorsque vous écrivez réellement le javadoc (un commentateur a souligné la fonctionnalité d'Eclipse qui fait cela).

Answer 3

Vous pouvez également placer votre curseur sur la ligne au-dessus d'une méthode que vous souhaitez utiliser dans JavaDoc, puis taper :

/**

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

Answer 4

Vous pouvez configurer Eclipse pour afficher des avertissements pour les éléments manquant de javadoc, ou avoir un javadoc qui ne contient pas toutes les informations ou contient des informations erronées.Il peut également insérer des modèles à remplir.

Ce n'est pas tout à fait l'outil que vous avez demandé, mais probablement mieux car vous ne vous retrouverez pas avec des squelettes vides sur les méthodes que vous avez manquées.

Vous pouvez y parvenir en examinant et en modifiant la page de préférences au-delà du chemin Fenêtre > Préférences > Java > Compilateur > 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, veuillez suivre le lien ci-dessous :

Aide sur les préférences Javadoc du compilateur Java

Answer 5

Sélectionnez la méthode que vous souhaitez ajouter Javadoc et alt+Changement+j, crée automatiquement le commentaire 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;
    }

Answer 6

Si vous cliquez avec le bouton droit sur la source d'un fichier dans Eclipse, il dispose d'une option de génération Javadoc sous le menu source.