Questions sur javadoc

19
réponses

Utilisez-vous Javadoc pour chaque méthode que vous écrivez? [fermé]

est-ce que je devrais écrire des commentaires Doc pour toutes mes méthodes java?
demandé sur 2008-10-17 08:04:20
4
réponses

Utilisation de javadoc pour la documentation Python [fermé]

je commence actuellement avec Python et j'ai un fond PHP fort et en PHP j'ai pris l'habitude d'utiliser javadoc comme ... '%priority%' : priority, '%message%' : message} return self.__pattern.format(**values)
demandé sur 2011-03-17 06:22:52
5
réponses

Comment puis-je générer des commentaires Javadoc dans Eclipse? [dupliquer]

possibilité de dupliquer: Javadoc template generator y a-t-il un moyen de générer des commentaires Javadoc dans Eclipse? Si oui, quel est-il?
demandé sur 2009-11-22 02:44:15
7
réponses

Générer javadoc uniquement avec JRE

je voudrais être capable de générer javadoc pour mes projets maven même si je tourne sous un JRE au lieu d'un JDK, où ... ur Eclipse qui est disponible à partir de Maven Central, et maintenant nous regardons à la génération de la javadoc.
demandé sur 2013-06-11 19:29:03
5
réponses

Ajout automatique du nom d'auteur dans Eclipse aux fichiers existants [closed]

y a-t-il un outil vraiment facile à utiliser (pas d'outil monstre) que je peux brancher dans Eclipse, et appuyer sur un bouton "generate header" et puis le nom des auteurs apparaît dans chaque fichier dans ce projet?
demandé sur 2011-10-31 23:17:16
2
réponses

Est-ce que "/* (non-javadoc)" a un sens bien compris?

Ne /* (non-javadoc) ont un sens, au-delà de montrer au lecteur de code source à un bloc de commentaire est intention ... t-il d'une convention établie? Si oui, que signifie-t-il (au-delà du sens littéral évident) et quand est-il utilisé?
demandé sur 2011-01-04 22:04:37
3
réponses

Eclipse: attache source / javadoc à une bibliothèque via une propriété locale

j'ai une bibliothèque tierce dans mon dépôt SVN et j'aimerais associer source/javadoc avec elle localement dans Eclips ... operties ) au lieu de passer par la fenêtre - > Préférences - > Général - > espace de travail - > Ressources liées?
demandé sur 2008-11-19 01:12:28
17
réponses

Maven ne fonctionne pas en Java 8 lorsque les tags Javadoc sont incomplets

depuis que J'utilise Maven, j'ai pu construire et installer dans mon dépôt local des projets qui ont des tags Javadoc ... ources, installer le projet et générer le bocal Javadoc en une seule étape comme il a été de travailler avec Java 7?
demandé sur 2013-04-08 22:23:36
3
réponses

Comment puis-je documenter les paquets en Java?

dans L'API Java, je peux voir les commentaires Javadoc pour les paquets. comment / où puis-je placer les commentaires Javadoc pour documenter un paquet?
demandé sur 2009-03-09 01:17:42
4
réponses

Utilisation de @see dans JavaDoc?

Quand dois-je utiliser @see pour traiter avec JavaDocs? Quelle est son utilisation? par exemple si MethodA ap ... et il me semble être incroyablement vague, il le dit signifie "voir aussi", mais pas vraiment ce que cela signifie!
demandé sur 2011-02-16 03:45:18
9
réponses

Comment générer automatiquement des commentaires pour getter / setter basé sur les commentaires de terrain dans Eclipse?

Je veux Qu'Eclipse génère automatiquement des commentaires Javadoc pour mes méthodes getter et setter basées sur les c ... solutions. J'ai vérifié http://jautodoc.sourceforge.net/ , mais semble comme il n'est pas capable de le faire.
demandé sur 2009-06-15 17:23:17
11
réponses

Comment voir JavaDoc dans IntelliJ idée? [dupliquer]

cette question a déjà une réponse ici: IntelliJ montrer JavaDocs info-bulle au su ... e obtenir rapidement des informations javadoc. Je dois au moins savoir quel type de méthode retourne.
demandé sur 2012-06-15 18:56:20
9
réponses

Générer JavaDocs avec Android Gradle plugin

Comment puis-je générer JavaDocs pour un projet Android en utilisant le nouveau système de construction Gradle? Voici ce ... 'ai pris est qu'il recueille les chemins de classe pour tous les variantes de construction, plutôt que d'en choisir une.
demandé sur 2013-06-11 02:30:49
3
réponses

Javadoc {@inheritDoc} class de la balise

je voudrais utiliser le {@inheritDoc} classe hérite des méthodes de ma classe abstraite. Dans la documentation de la clas ... hérite de la documentation de la super classe, elle remplace le nom de la classe abstraite par le nom de la sous-classe?
demandé sur 2010-01-29 23:39:55
3
réponses

Comment faire pour que les classes générées contiennent Javadoc à partir de la documentation du schéma XML

je travaille actuellement avec un schéma XML qui a <xsd:annotation>/<xsd:documentation> sur la plupart des ty ... complexTypes est utilisé et simpleType s (qui peut aussi donner une classe) et les éléments sont toujours sans Javadoc.
demandé sur 2009-10-30 17:48:47
5
réponses

JavaDoc pour les méthodes privées / protégées? [fermé]

devrais-je écrire JavaDoc pour privé ou protégé méthodes? Et que dire privé variables? je vois exemples de classe sur mo ... sont Javadoc'ed. Donc je ne peux pas comprendre si C'est une bonne pratique de JavaDoc le privé (ou protégé) méthodes.
demandé sur 2014-02-07 19:49:29
5
réponses

Intellij génère javadoc pour les méthodes et les classes

est-il possible de configurer Intellij pour générer javadoc pour les méthodes et les classes, automatiquement, avec @autho ... a économiserait des centaines d'actions manuelles. J'utilise IntelliJ Idea 9.0 BETA Community Edition, # IC-90.96. TIA.
demandé sur 2009-12-04 00:32:50
5
réponses

Exemple de Code avec annotation dans JavaDoc

mon JavaDoc ne fonctionne pas quand j'ai un exemple de code avec une annotation. des suggestions? /** * <pre> * ... </pre> */ @Retention(RetentionPolicy.RUNTIME) @Target({ElementType.METHOD}) public @interface DemoAnnotation {
demandé sur 2010-04-14 12:59:40
4
réponses

Comment formater un extrait de code dans Javadoc avec les symboles @ et {à l'intérieur?

C'est ce que j'essaie de faire: /** * <pre> * {@code * &#64;XmlRootElement * public final class Page &# ... conduit à des avertissements javadoc et à un formatage absolument incorrect. Qu'est ce qu'une solution de contournement?
demandé sur 2011-11-06 16:31:50
3
réponses

Javadoc dans les classes de test de Junit?

Est-il conseillé de mettre des commentaires Javadoc dans junit test de classes et de méthodes? Ou est l'idée qu'ils doivent être vraiment facile à lire et simple qu'il est inutile de fournir une description de l'essai l'intention?
demandé sur 2010-06-03 20:44:31