web-dev-qa-db-fra.com

Comment ajouter un bloc de commentaires aux méthodes dans Eclipse?

Est-il facile d’ajouter un bloc de commentaires (style Javadoc) à chaque méthode d’un projet Eclipse et éventuellement à des classes afin que je puisse les compléter plus tard?

javaeclipsejavadoc
19
Kalimah Apps

Comme suggéré, vous pouvez le faire méthode par méthode (Source -> Générer un commentaire d'élément) ou ALT+SHIFT+J, mais je trouve que c'est une très mauvaise idée. Les commentaires ne sont utiles que lorsqu'ils donnent une information supplémentaire. Si vous pensez que plus d'informations sont nécessaires, ajoutez-les.

Avoir des commentaires sur les setters comme " définit la valeur " ou pire, génère automatiquement des commentaires inutiles.

32
Matteo

Sous 

Fenêtre | Préférences | Java | Style de code | Modèles de code 

vous trouverez 2 fonctionnalités: 

  • Ajouter automatiquement des commentaires pour les nouvelles méthodes ou types
  • Commentaires | Les méthodes | Modifier...

Vous pouvez éditer le bloc de commentaires généré à l'aide de variables Eclipse ou de votre texte Javadoc statique.

8
r2d2

Pour ajouter un commentaire sur la méthode, sélectionnez getUserou, prenez le curseur avant getUseret appuyez sur ALT + MAJ + J. Le commentaire s'ajoutera au-dessus de votre méthode.

/*
* @param
* @return User
*/
public User getUser();
5
David

Peut-être que vous cherchez ceci 

http://jautodoc.sourceforge.net/

2
user454083

le plus simple est de taper/** et d’appuyer sur Entrée en haut de la méthode, là où vous voulez générer un commentaire. Il génère automatiquement le commentaire d’élément.

2
Trinadh Koya

Utilisateurs Mac: ⌃-⌥-J

  • Option -
  • Contrôle - ⌃

Utilisateurs Windows: Shift-Alt-J

PS: Assurez-vous que vous avez le plugin JAutodoc installé

0
f-society

suivez ces étapes et vous le ferez facilement . dans Eclipse, sélectionnez Projet -> générer javadoc -> appuyez sur Entrée, puis sélectionnez votre projet à documenter.

0
Noorullah