La programmation javadoc

3

Comment référencer une méthode en javadoc?

Comment puis-je utiliser la @linkbalise pour créer un lien vers une méthode? Je veux changer: /** * Returns the Baz object owned by the Bar object owned by Foo owned by this. * A convenience method, equivalent to getFoo().getBar().getBaz() * @return baz */ public Baz fooBarBaz() à: /** * Returns …

864 java hyperlink javadoc

5

Lien vers une URL externe dans Javadoc?

Quelque chose comme: /** * See {@linktourl http://google.com} */

768 java url javadoc hyperlink

15

Exemple de code de plusieurs lignes dans un commentaire Javadoc

J'ai un petit exemple de code que je veux inclure dans le commentaire Javadoc pour une méthode. /** * -- ex: looping through List of Map objects -- * <code> * for (int i = 0; i < list.size(); i++) { * Map map = (Map)list.get(i); * System.out.println(map.get("wordID")); * System.out.println(map.get("word")); …

531 java html javadoc

4

Comment ajouter une référence à un paramètre de méthode dans javadoc?

Existe-t-il un moyen d'ajouter des références à un ou plusieurs paramètres d'une méthode à partir du corps de documentation de la méthode? Quelque chose comme: /** * When {@paramref a} is null, we rely on b for the discombobulation. * * @param a this is one of the parameters * …

313 java arguments javadoc

17

Maven ne fonctionne pas dans Java 8 lorsque les balises Javadoc sont incomplètes

Depuis que j'utilise Maven, j'ai pu créer et installer dans mes projets de référentiel local des balises Javadoc incomplètes (par exemple, un paramètre manquant). Cependant, depuis que j'ai migré vers Java 8 (1.8.0-ea-b90) Maven est absolument strict sur les balises de documentation manquantes et me montre beaucoup d'erreurs Javadoc liées …

312 java maven migration java-8 javadoc

12

Comment attacher javadoc ou des sources aux fichiers JAR dans le dossier libs?

Nouvelle version du plugin ADT r17 pour Eclipse, fonctionnalité ajoutée pour configurer automatiquement les dépendances JAR. Tous les fichiers .jar du dossier / libs sont maintenant ajoutés à la configuration de génération. Malheureusement, le conteneur de chemin de classe des dépendances Android n'est pas modifiable. Comment puis-je attacher javadoc et …

254 android eclipse adt javadoc

3

Lien Javadoc vers la méthode dans une autre classe

Actuellement, je référence des méthodes dans d'autres classes avec cette syntaxe Javadoc: @see {@link com.my.package.Class#method()} Et dans ce que je comprends de la documentation, c'est la bonne façon de le faire. Mais maintenant, pour la partie amusante ou frustrante. Lorsque je génère ce javadoc, j'obtiens tout d'abord l'erreur suivante: warning …

238 java javadoc

1

Javadoc: package.html ou package-info.java

Lorsque vous essayez de créer des commentaires Javadoc au niveau du package, quelle est la méthode préférée? Que faire? package-info.java Avantages Plus récent Les inconvénients Abus d'une classe - Les classes sont pour le code, pas seulement pour les commentaires package.html Avantages L'extension HTML signifie que ce n'est pas du …

230 java javadoc

16

Comment générer des commentaires javadoc dans Android Studio

Puis-je utiliser des touches de raccourci dans Android studio pour générer des commentaires javadoc? Sinon, quelle est la façon la plus simple de générer des commentaires javadoc?

204 android-studio javadoc

9

/ ** et / * dans les commentaires Java

Quelle est la différence entre /** * comment * * */ et /* * * comment * */ en Java? Quand dois-je les utiliser?

198 java comments javadoc

5

codestyle; mettre javadoc avant ou après l'annotation?

Je sais que ce n'est pas le problème le plus vital, mais je viens de réaliser que je peux mettre le bloc de commentaires javadoc avant ou après l'annotation. Que voudrions-nous adopter comme norme de codage? /** * This is a javadoc comment before the annotation */ @Component public class …

187 java coding-style annotations javadoc code-documentation

3

Javadoc @see ou {@link}?

Quelqu'un pourrait-il me dire la différence entre javadoc @seeet{@link} ? Ou plutôt, quand utiliser lequel d'entre eux?

184 java javadoc

5

Comment pouvez-vous échapper au caractère @ dans javadoc?

Comment puis-je échapper au @symbole dans javadoc? J'essaie de l'utiliser dans une {@code}balise, qui se trouve à l'intérieur des <pre>balises. J'ai déjà essayé la &#64;séquence d' échappement html , mais cela n'a pas fonctionné.

183 java escaping javadoc

3

Comment documenter des packages en Java?

Dans les API Java, je peux voir les commentaires Javadoc pour les packages. Comment / où placer les commentaires Javadoc pour documenter un package?

182 java packages javadoc

17

Obtenir les fichiers jar source attachés à Eclipse pour les dépendances gérées par Maven

J'utilise Maven (et l'intégration Maven Eclipse) pour gérer les dépendances de mes projets Java dans Eclipse. La fonction de téléchargement automatique des fichiers JAR à partir des référentiels Maven est un gain de temps réel. Malheureusement, il n'inclut pas la documentation API et le code source. Comment puis-je configurer Maven …

178 eclipse maven-2 javadoc

Questions marquées «javadoc»