Fermé. Cette question ne répond pas aux directives de Stack Overflow . Il n'accepte pas les réponses actuellement. Vous souhaitez améliorer cette question? Mettez à jour la question pour qu'elle soit pertinente pour Stack Overflow. Fermé il y a 3 ans . Améliorez cette question existe-t-il un bon...
Quelle convention utilisez-vous pour commenter les getters et les setters? C'est quelque chose que je me demande depuis un certain temps, par exemple: /** * (1a) what do you put here? * @param salary (1b) what do you put here? */ public void setSalary(float salary); /* * (2a) what do you put here?...
Je n'aime pas les Javadocs par défaut générés pour moi lorsque je crée une classe ou des méthodes, en particulier la variable @author, qui est le nom d'utilisateur système actuel sur ma boîte Windows. Je voudrais le changer. Est-ce
Si j'écris <xmlElement>dans un javadoc, cela n'apparaît pas, car les balises ont des fonctions spéciales sur le formatage des textes. Comment puis-je afficher ces caractères dans un
En utilisant Javadoc 1.5, je n'ai pas pu créer un @link vers une valeur d'énumération. Ce que je voudrais faire, c'est créer un Enum comme celui-ci: public enum Planet { /** * MERCURY is a fun place. */ MERCURY, /** * VENUS is more fun. */ VENUS, /** * But nothing beats the Earth. */ EARTH, /** *...
Lorsque je code chez Netbeans, il complète automatiquement le code et affiche les Javadocs. Cependant, lorsque j'utilise Intellij IDEA, si je clique sur Ctrl+,Space je peux voir l'auto-complétion et si je clique sur Ctrl+,Q je peux voir le javadoc séparément. Est-il possible de voir le Javadoc de...
Lors de la création d'une nouvelle classe ou interface dans l'EDI Netbeans, une balise "@author ...." apparaît. Comment changer sa valeur? Si possible, j'aimerais le changer en utilisant le menu Netbeans et non en éditant certains fichiers de configuration :) J'utilise Netbeans...
Quand est-ce que j'utilise @see lorsque travaille avec JavaDocs? Quelle est son utilisation? Par exemple , si les MethodAappels MethodBalors dois - je mettre @seedans MethodBla javadoc et référence » MethodAparce que c'est ce qui l'a appelé, ou dois - je mettre une référence à MethodBpartir...
Est-il correct d'ajouter des commentaires Javadoc dans l'interface et d'ajouter des commentaires non-Javadoc dans l'implémentation? La plupart des IDE génèrent des commentaires non JavaDoc pour les implémentations lorsque vous générez automatiquement des commentaires. La méthode concrète ne...
À l'aide de JavaDoc, comment puis-je référencer la valeur d'un champ statique final dans la classe? Je veux que le ???dans cet exemple soit remplacé par la valeur du champ STATIC_FIELD. /** * This is a simple class with only one static field with the value ???. */ public class Simple { /** * We can...
Je me trouve souvent face à un dilemme lors de l'écriture de javadoc pour les propriétés / membres d'une classe POJO "simple" ne contenant que des propriétés et des getters et setters (style DTO) ... 1) Ecrire javadoc pour la propriété ou ... 2) Ecrire javadoc pour le getter Si j'écris javadoc...
Je migre d'Eclipse vers Intellij Idea. Une chose que je ne pouvais pas encore comprendre est la saisie semi-automatique de la @authorbalise JavaDoc. Lors de la saisie @adans Eclipse, il y a deux propositions: @author - author name @author Comment obtenir la première proposition dans Intellij...
Supposons que, dans le cadre de la documentation de votre code (Javadoc), vous souhaitiez indiquer que les relations entre les éléments utilisent une indentation profonde. Comment puis-je créer une liste imbriquée comme: un élément un autre élément encore un autre élément...
J'ai examiné la référence JavaDoc , et bien que je comprenne la différence fondamentale entre @see(divers liens) et {@inheritDoc}(exportation du commentaire JavaDoc de superclasse), j'ai besoin de clarifications sur la façon dont les choses sont réellement implémentées. Dans Eclipse IDE, lorsque...
Exit code: 1 - javadoc: error - The code being documented uses packages in the unnamed module, but the packages defined in https://docs.oracle.com/en/java/javase/11/docs/api/ are in named modules. Quelqu'un a-t-il pu faire fonctionner javadoc sans avoir à changer la version source en 1.8 (comme...
Comment doit-on documenter les paramètres d' enregistrement Java ? Je fais référence aux paramètres qui finissent par devenir des paramètres constructeurs, des champs de classe. J'ai essayé: /** * @param name the name of the animal * @param age the age of the animal */ public record Animal(String...