Articles of javadoc

Comment faire pour que les classes générées contiennent la documentation Javadoc de XML Schema

Je travaille actuellement avec un schéma XML comportant / sur la plupart des types et des éléments. Lorsque je génère des beans Java à partir de ce schéma XML, le Javadoc de ces beans ne contient que des informations génériques générées sur le contenu autorisé du type / élément. Je voudrais voir le contenu de […]

Puis-je append JavaDoc à un package facilement avec Eclipse?

J’utilise javadoc pour documenter mes classes et méthodes. J’aimerais aussi append des informations générales sur mes paquets. J’aime comment Eclipse crée un stub correspondant à un commentaire de document pour chaque classe ou méthode une fois que je tape /** . Eclipse dispose-t-il également d’un moyen simple de générer un fichier package.html ?

Un moyen de générer automatiquement tous les commentaires Javadoc dans Eclipse?

Je sais que vous pouvez appuyer sur Maj + Alt + J pour insérer un modèle de commentaire approprié pour le bloc de code en cours, mais y a-t-il un moyen de laisser éclater éclipse et de faire un projet comme celui-ci?

Le formateur Eclipse ajoute de l’espace dans les lignes de commentaires vides

Le formateur de code eclipse ajoute un espace de fin dans chaque ligne de commentaire Javadoc vide (voir capture d’écran). Le formateur d’un collègue supprime toujours ces espaces (et produit donc des diff SVN ennuyeux). Il prétend utiliser les mêmes parameters de formatage (fichier XML). Néanmoins, j’ai essayé toutes les options de l’onglet Commentaires de […]

Comment append des commentaires au niveau du package dans Javadoc?

J’utilise Check-Style, FindBugs et PMD pour valider mon code Java. J’ai corrigé presque tous les bugs détectés par ces outils. Je ne suis pas capable de comprendre comment écrire “commentaire de paquet” qui est un bug pris par checkstyle. J’ai parcouru la documentation de Check-Style, mais je ne le comprends pas. Quelqu’un pourrait-il m’aider à […]

Ajout automatique du nom de l’auteur dans Eclipse aux fichiers existants

Existe-t-il un véritable outil facile à utiliser (pas d’outil monstre) que je peux twigr sur Eclipse, et appuyer sur un bouton «générer un en-tête» et le nom des auteurs apparaît dans chaque fichier de ce projet?

Classe de balises Javadoc {@inheritDoc}

Je voudrais utiliser la classe {@inheritDoc} pour hériter des méthodes de ma classe abstraite. Dans la documentation de la classe abstraite, je fais référence à la classe abstraite par son nom. Comment est-ce que je peux taguer ceci alors quand la sous-classe hérite de la documentation de la super classe, elle remplace le nom de […]

Dans Javadocs, comment dois-je écrire des formes plurielles d’objects singuliers dans les balises ?

J’ai une classe nommée Identity . Dans mes commentaires javadoc, je le désigne comme un pluriel. Je peux penser à deux solutions: changer la référence à Identities ou Identity s. Ni l’un ni l’autre ne se sentent bien, et je me demande s’il existe une meilleure solution. Voici un exemple pour plus de clarté: /** […]

JavaDoc dans un projet Android Eclipse

Dans notre projet Android, notre code est JavaDoc’d et cela génère tout correctement. Cependant, toute référence aux classes / fonctions de l’API Android entraîne une erreur JavaDoc et un lien vers les informations pertinentes n’est pas généré. Au lieu de cela, nous obtenons des noms de classe en texte brut. Comment pouvons-nous configurer Eclipse pour […]

Comment puis-je activer javadoc pour la bibliothèque de support Android?

Lorsque vous utilisez la bibliothèque de support Android pour la compatibilité et essayez d’afficher le javadoc pour, par exemple, FragmentTransaction , j’obtiens l’erreur suivante car aucun fichier javadoc n’est associé: android.support.v4.app.FragmentTransaction Remarque: Cet élément n’a pas de source attachée ni de javadoc attaché et aucun Javadoc n’a donc pu être trouvé. La bibliothèque de support […]