Comment documenter une méthode qui remplace une autre méthode?
Je me suis toujours demandé comment documenter une méthode qui remplace un message à partir d'une classe de base.
Normalement je ajouter un java doc pour chaque méthode publique, et pour certains, privé, protégé méthodes.
Mais autogenerating un bloc de documentation pour remplacer la méthode dans eclipse produit quelque chose comme ceci:
/*
* (non-Javadoc)
*
* @see javax.swing.JComponent#paintComponent(java.awt.Graphics)
*/
Est-ce une bonne façon de documenter la remplacer? Dois-je hériter/copie de la documentation de la classe de base?
Que faites-vous en tant que documentation de ce cas particulier?
Je voudrais avoir une vue d'ensemble des pratiques qui sont utilisées.
dupliquer: stackoverflow.com/questions/1081408/...
vous avez modifié une question qui est à peu près exactement le même que celui que vous venez de lui demander? génial, mec.
Pas vraiment... Voici votre +1 arrière
J'ai posé cette question dans un commentar à la question, mais ensuite j'ai pensé que ma question est plus générale, et d'avoir un tas de gens commentent sur ma quetion dans le commentaire serait d'aucune utilité pour la personne qui a posé plus de question spéciale
Autre question, comment faire pour hériter de java docs. Cette question porte sur les meilleures pratiques
vous avez modifié une question qui est à peu près exactement le même que celui que vous venez de lui demander? génial, mec.
Pas vraiment... Voici votre +1 arrière
J'ai posé cette question dans un commentar à la question, mais ensuite j'ai pensé que ma question est plus générale, et d'avoir un tas de gens commentent sur ma quetion dans le commentaire serait d'aucune utilité pour la personne qui a posé plus de question spéciale
Autre question, comment faire pour hériter de java docs. Cette question porte sur les meilleures pratiques
OriginalL'auteur Janusz | 2009-07-04
Vous devez vous connecter pour publier un commentaire.
De chaque méthode - private, protected public - doivent être documentés en décrivant ce qu'il fait. Oublier d'hériter de la documentation d'une classe de base - vous pouvez inclure un lien si vous le souhaitez, mais tant que l'information est là qu'il remplace une méthode héritée alors que l'autre personne est libre de le chercher pour eux-mêmes. SEC - ne pas se répéter - document de la méthode de classe de base dans un seul endroit.
Je ne pense même pas qu'il est bon de document de la méthode elle l'emporte, parce que cela peut changer, et il sera difficile de le garder à jour si vous insérez de nouvelles classes dans la hiérarchie entre votre classe et de la classe de base. Simplement les informations qu'il remplace une méthode héritée est suffisant.
Si vos méthodes sont trop complexes pour document en quelques lignes de commentaires, alors qu'ils sont probablement trop complexe et doit être refait.
OriginalL'auteur Larry Watanabe
y compris l' @Override annotation devrait être suffisant pour envoyer un curieux développeur pour le super.
OriginalL'auteur akf