Je suis un grand fan de GROSTDOC Commentaire automatique de GhostDoc dans Visual Studio, donc am Vous recherchez un plugin qui fait le même travail avec mon code Java à Eclipse. Toute recommandation?
5 Réponses :
jamais utilisé Ghostdoc, donc pas sûr de quelle fonctionnalité supplémentaire il donne, mais s'il s'agit de générer des commentaires de type et de méthode basé sur le nom, les paramètres, le type de retour, etc., Eclipse l'a intégrée, donc aucune extension requise.
Il est essentiellement l'équivalent de Javadoc, qui peut générer en éclipse avec le raccourci:
alt + shift + j
(Lorsque vous êtes dans la fonction Java, vous souhaitez ajouter Javadoc pour)
à partir de là, si vous voulez vraiment un format XML, vous pouvez essayer et Utilisez une Jeldoclet
Vous pouvez souligner que vous pouvez modifier le Javadoc généré via Windows-> Préférences-> Java-> Style de code-> Modèles de code
Le générateur Javadoc intégré d'Eclipse n'est nulle part près des fonctionnalités fournies par Ghostdoc. Voir la réponse de Kerry Carroll.
GHOSTDOC a une belle fonctionnalité supplémentaire qui déduit une description de la méthode de l'analyse du nom de la méthode et de la fourniture de la documentation squelettique. Par exemple, utiliser ghostdoc sur une méthode nommée getdocumentName () peut renvoyer la phrase "obtient le nom du document". Bien que cela ne soit pas plus d'informations que prévu par le nom de la méthode, il ajoute une documentation de méthode dans laquelle il n'existait auparavant. Certains pourraient soutenir que cela est à peine utile. Je discute au contraire car il prend en charge la génération de documentation à partir du code source (par exemple, pour des outils tels que NDOC ou SANDCASTLE).
À mon avis, le plus grand avantage de Ghostdoc sur «Generate Element Commentaire» de Ghostdoc est qu'il encourage les programmeurs à commencer à ajouter des commentaires de la documentation en ajoutant une manière extrêmement rapide et fiable. Le programmeur peut accepter le texte déduit (adapté dans 50 à 80% des cas), ou étendre à ce sujet pour des méthodes plus complexes. Pour le programmeur junior qui n'est pas aussi familier avec la manière dont les commentaires de la documentation sont utilisés, cela peut raccourcir rapidement la courbe d'apprentissage et encourager de bonnes pratiques de programmation.
Vous pouvez vérifier jautodoc ( http://jautodoc.sourceforge.net/ )
De l'auteur:
Jautodoc est un plugin Eclipse pour Ajouter automatiquement javadoc et fichier en-têtes sur votre code source. Il génère éventuellement des commentaires initiaux du nom de l'élément en utilisant la vitesse Modèles pour Javadoc et fichier en-têtes.
Celui-ci est celui que j'ai trouvé le plus proche de Ghostdoc.
Javadoc n'est pas comme Ghostdoc mon ami. Javadoc crée uniquement la structure afin que l'on puisse écrire la documentation à partir de zéro. Ghostdoc remplit effectivement les informations en fonction de la méthode / nom de la propriété.
Exemple: Jautodoc est le plus proche que j'ai trouvé jusqu'à présent, mais ce n'est pas aussi magique que Ghostdoc.