Préférences Javadoc du compilateur Java

Indiquez vos préférences pour les paramètres Javadoc dans la page des préférences Ouvre la page des préférences Javadoc Java > Compilateur > Javadoc.

Option

Description

Valeur par défaut

Traiter les commentaires Javadoc (comprend la recherche et la restructuration)

Le compilateur détecte les erreurs dans les commentaires Javadoc lorsque cette option est activée. Pour que la recherche et la restructuration fonctionnent sur les commentaires Javadoc, il faut également que cette option soit activée.

Activé

Structure incorrecte des commentaires Javadoc

Lorsque cette option est activée, le compilateur émet une erreur ou un avertissement lorsqu'il rencontre un commentaire Javadoc dont la structure n'est pas correcte.

Ignorer

Considérer uniquement les membres visibles comme

Le compilateur ne vérifie que les membres ayant la visibilité spécifiée ou dont la visibilité est plus étendue.

Public

Valider les arguments de balise (@param, @throws, @exception, @see, @link)

Lorsque cette option est activée, le compilateur émet une erreur ou un avertissement chaque fois qu'il rencontre une erreur dans un argument de balise de commentaire Javadoc pour @param, @throws, @exception, @see ou @link.

Désactivé

Signaler les références non visibles

Lorsque cette option est activée, le compilateur émet une erreur ou un avertissement chaque fois qu'il rencontre une référence à un élément non visible.

Désactivé

Signaler les références obsolètes

Lorsque cette option est activée, le compilateur émet une erreur ou un avertissement chaque fois qu'il rencontre une référence à un élément obsolète.

Désactivé

Descriptions de balise manquantes

Choisissez entre 'Valider toutes les balises standard', 'Valider les balises @return' et 'Ignorer'. Lorsque cette option est activée, le compilateur émet une erreur ou un avertissement lorsqu'il rencontre une description de balise manquante.

'Valider les balises @return'

Balises Javadoc manquantes

Lorsque cette option est activée, le compilateur émet une erreur ou un avertissement chaque fois qu'il détecte une balise Javadoc manquante (par exemple la balise @param manquante pour un paramètre).

Ignorer

Considérer uniquement les membres visibles comme

Le compilateur ne vérifie que les membres ayant la visibilité spécifiée ou dont la visibilité est plus étendue.

Public

A ignorer dans les méthodes de substitution et d'implémentation

Lorsque cette option est activée, les méthodes qui remplacent ou implémentent une autre méthode ne sont pas examinées à la recherche de balises Javadoc manquantes.

Activé

Ignorer les paramètres de type de méthode

Lorsque cette option est activée, les balises Javadoc manquantes ne sont pas signalées pour les paramètres de type de méthode.

Activé

Commentaires Javadoc manquants

Lorsque cette option est activée, le compilateur émet une erreur ou un avertissement chaque fois qu'il détecte un commentaire Javadoc manquant dans un membre Java.

Ignorer

Considérer uniquement les membres visibles comme

Le compilateur ne vérifie que les membres ayant la visibilité spécifiée ou dont la visibilité est plus étendue.

Public

A ignorer dans les méthodes de substitution et d'implémentation

Lorsque cette option est activée, les méthodes qui remplacent ou implémentent une autre méthode ne sont pas examinées à la recherche de commentaires Javadoc manquants.

Activé