La meilleure façon de commenter le code en Java

Quelle est la meilleure façon de commenter le code en Java, il est un moyen pour générer le nom de la fonction et les paramètres automatiquement dans Eclipse ?

Par exemple je suis à la rédaction de ces commentaires manuellement :

//<summary>
//Some comments about the function
//</summary>
//<param name="id">the user ID</param>
//<param name="username">The user password</param>
//<returns></returns>
public Connect(int id, String password)
{

}

Merci déjà.

  • dans eclipse, avant la méthode, tapez: /** et appuyez sur entrée
  • L'utilisation de javadoc pour cela. Cela permet pour la génération automatique de la documentation, ce qui est agréable.
  • La véritable question, pourquoi êtes-vous les gars commenter plutôt que d'ajouter des réponses...?
InformationsquelleAutor Wassim AZIRAR | 2011-07-01
  1. 2

    Personnellement, je préfère utiliser JAutodoc plugin pour les commentaires. Prendre un coup d'oeil. Sa bonne.

    • Oui, mais auto-généré javadoc commentaires sont inutiles. Il est préférable d'utiliser CTRL+ALT+J ajouter le commentaire squelettes ... et puis tout de suite ajouter les commentaires.
    InformationsquelleAutor Tapas Bose
  2. 10

    Prendre un coup d'oeil à Javadoc

    Javadocs peut être facilement généré dans Eclipse. Vous pouvez taper /** et de saisie semi-automatique. Vous pouvez également configurer vos modèles de code pour générer automatiquement la documentation javadoc.

    • Je parle de l'écriture de code dans le fichier source, et de ne pas générer de java doc sir.
    • Modifié la réponse. Changé le lien, ne signifie pas de lien vers le générateur de l'outil, mais à la javadoc de la documentation en général.
    InformationsquelleAutor wjans
  3. 7

    Sélectionnez la méthode pour laquelle vous voulez des commentaires, puis appuyez sur MAJ, ALT et J ensemble.

    Prendre le temps d'apprendre à propos de JavaDoc que c'est une très riche de la zone pour la documentation de votre code.

    InformationsquelleAutor Brian
  4. 4

    Par convention, c'est la façon de le faire:

    /** Some comments about the function
  * 
  * @param id the user ID
  * @param username The user password
  *
*/
public Connect(int id, String password)
{

}

    Si votre méthode renvoie rien, vous ajoutez un `@return", suivi d'une explication.

    Vous IDE et la norme JavaDoc outil sera en mesure d'analyser cela.

    InformationsquelleAutor Mathias Schwarz
  5. 2

    Il semble y avoir une certaine confusion sur ce fil. La séquence de touches que j'utilise pour générer des commentaires javadoc est MAJ+ALT+J pas CTRL?

    • J'ai aussi utiliser la touche MAJ et pas de CTRL. Je ne sais pas pourquoi les autres vous recommandons la combinaison avec la touche CTRL.
    InformationsquelleAutor bazza2000
  6. 1

    Le meilleur moyen est d'utiliser la JavaDoc et eclipse a construit dans les modèles de code pour le faire.

    Si vous voulez avoir le format vous ai montré ici, vous pouvez écrire vos propres modèles. Les modèles de fonctionnalité va vous permettre d'insérer des variables, dont l'un sera le nom de la méthode.

    InformationsquelleAutor spot35
  7. 1

    Je dirais que la meilleure façon de commenter le code en java est de fournir des noms significatifs pour vos méthodes et des noms de variables 🙂

    class MyService {
    public void authenticateUser(int userId, String userPassword) {...}
}
    InformationsquelleAutor denis.solonenko
  8. 1

    Le meilleur moyen est d'utiliser la Javadoc format de commentaire, pas celui que vous avez indiqué dans la question.

    Dans Eclipse, placez votre curseur sur le nom de la méthode et appuyez sur Ctrl+Alt+J. Il va générer un commentaire Javadoc avec tous les paramètres indiqués.

    Vous pouvez également contrôler la façon dont Javadoc commentaire est généré dans la Fenêtre de l' -> Préférences -> Java -> Style de Code -> Modèles de Code -> Commentaires

    InformationsquelleAutor Andrey Adamovich
  9. 1

    Vous devez appuyer sur CTRL+ALT+J en même temps avoir le curseur sur la déclaration en ligne.

    InformationsquelleAutor Thiib
  10. 0

    Je suggère d'aller avec le raccourci alt+shift+j pour Eclipse, et écrire la description de la fonction pour que d'autres développeurs puissent comprendre ce que la fonction peut faire et aussi cette auto commentant les fonctionnalités de fournir @param et @return attributs de sorte que vous pouvez spécifier ce qui doit être nécessaire et ce qui devrait être prévu pour l'exécution de la fonction.

    Par Exemple:

    /**
 * @param msg
 * will return the converted message from the byte[] msg
 * @return
 */
    InformationsquelleAutor Darshan Shah