Questions marquées «javadoc»

Javadoc est un système de génération de documentation extensible qui lit les commentaires spécialement formatés dans le code source Java et génère une documentation compilée. Il est généralement utilisé pour produire de la documentation API sous la forme de pages Web HTML.

Comment puis-je référencer la valeur d'un champ statique final dans la classe?

À 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 …

96 java documentation javadoc

Comment écrire Javadoc de propriétés?

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 …

93 java javadoc

Auto-complétion de @author dans Intellij

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 (est-ce même possible?)? Et …

93 intellij-idea javadoc

Comment créer plusieurs niveaux d'indentation dans Javadoc?

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

88 documentation javadoc indentation nested-lists

Détails de la différence entre @see et @inheritDoc

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 je sélectionne «Générer des commentaires d'élément» pour la méthode …

87 java javadoc comments

JDK 11+ et Javadoc

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 suggéré dans d'autres forums)? J'utilise JDK v11.0.5 …

13 java maven javadoc java-11 maven-javadoc-plugin

Comment documenter les paramètres d'enregistrement Java?

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 name, int …

12 java intellij-idea javadoc java-14 java-record

En utilisant notre site, vous reconnaissez avoir lu et compris notre politique liée aux cookies et notre politique de confidentialité.

Licensed under cc by-sa 3.0 with attribution required.