Comment puis-je mettre à jour automatiquement le Javadoc en changeant la signature de la méthode dans Eclipse?

J'utilise Eclipse IDE pour mon projet Java.

j'ai un problème. J'ai les méthodes de mon projet qui ont la javadoc des commentaires comme suit:

/**
 * Retruns the string representation of a input stream
 * @param in
 * @return
 * @throws IOException
 */
public static String getStringFromInputStream (InputStream in) throws IOException {
    StringBuffer out = new StringBuffer();
    byte[] b = new byte[4096];
    for (int n; (n = in.read(b)) != -1;) {
        out.append(new String(b, 0, n));
    }
    return out.toString();
}

maintenant je veux savoir qu'il y a un moyen par lequel chaque fois que je fais des changements dans la signature de ma méthode, ces changements se reflètent dans le javadoc automatiquement.

24
demandé sur Paŭlo Ebermann 2010-02-14 09:47:10
la source

6 ответов

Eclipse fournit assez bonnes options pour assurer l'exactitude de javadoc outre le Renommer refactoriser JesperE mentionné:

  • Modifier la signature de la méthode refactoriser opération modifie également la javadoc (ajouter/supprimer des balises nécessaires). Vous devez utiliser celui-ci ou Renommer pour modifier le code déjà utilisé.
  • Si vous activez ajouter des tags JavadocPréférences/Java/Éditeur/En Tapant page puis Eclipse génère le bon tampon javadoc après avoir tapé /**+ Entrée avant une méthode.

Vous pouvez également définir des options de compilateur pour vérifier les balises manquantes de javadoc sur Préférences/Java/Compilateur/Javadoc. Dans ce cas, vous obtenez des avertissements du compilateur sur les étiquettes manquantes/supplémentaires et vous avez quickfix ( Ctrl+1) pour les réparer. C'est une bonne option pour s'assurer de l'exactitude de l'existant javadoc dans le long terme.

11
répondu Csaba_H 2010-02-15 15:45:13
la source

Je ne sais pas comment synchroniser automatiquement L'en-tête Javadoc, mais si vous renommez un paramètre en utilisant Ctrl-1+ Rename in file, L'en-tête Javadoc est correctement renommé.

4
répondu JesperE 2010-02-14 09:55:18
la source

le remaniement avec L'option" Mise à jour des références " n'est pas suffisant. Vous devez vous assurer que "Process Javadoc comments" est coché dans Window->Preferences, Java->compilateur->Javadoc. Tweak la page de préférence comme vous préférez et il fonctionnera très bien.

3
répondu Mat 2014-04-03 12:17:22
la source

appuyez simplement sur ALT+SHIFT+j sur le nom de la méthode et supprimez les lignes supplémentaires:

AVANT:

/**
 * Copies all the details from the passed template into the passed new
 * header.
 *
 * @param pNewHeader
 */
private void doCopy(int pNewHeader, int pTemplate) {

APRÈS:

/**
 * Copies all the details from the passed template into the passed new
 * header.
 *
 * @param pNewHeader   << DELETE
 */                    << DELETE
/**                    << DELETE
 * @param pNewHeader
 * @param pTemplate
 */
private void doCopy(int pNewHeader, int pTemplate) {
2
répondu Yaza Fatutu 2016-02-16 17:12:01
la source

Appuyez sur Atl+Shift+R et changez

1
répondu Yatendra Goel 2010-02-14 15:58:21
la source

comme j'ai commenté le scénario, dans lequel le réflecteur ne fonctionnera pas

répondre à refactoriser option. Mais que faire si j'ai ajouté un nouveau param ou supprimé un param de la méthode signature. Dans ce cas, comment mettre à jour la javadoc?

il y a une solution que j'ai trouvée, mais oui ce n'est toujours pas un processus automatisé et n'est pas bon pour un grand nombre de changements.

La solution est d',

1. supprimer la commentaire javadoc et de le rendre plaine commentaire c'est à dire de mise à jour de l' /**' and change it to just/*'.

2. Maintenant encore une fois juste au-dessus de la méthode signature/déclaration entrer /** et appuyez sur entrée. Il reconstituerait les paramètres mis à jour et retournerait les informations. Maintenant, déplacez les lignes de description de l'ancien commentaire vers le nouveau.

3. Vous pouvez utiliser Alt+ /Bas flèches pour y parvenir.

4. Fait supprimer le vieux commentaire javadoc après c'est copié à l'emplacement correct.

1
répondu mtk 2015-01-30 12:28:53
la source

Autres questions sur