Avertissement: commentaire Javadoc pendant
Depuis que j'ai mis à jour mon Android Studio (2.3.1) et construit des outils (2.3.1), je reçois un avertissement,
Avertissement: commentaire Javadoc pendant
pour des commentaires comme
/** set name with format, {@Link FORMAT_NAME} **/
setNameText(getFormattedName(FORMAT_NAME));
Comme vous pouvez le constater, j’utilise le commentaire de style javadoc pour les liens et autres. Je me demande s'il existe d'autres alternatives de commentaires qui ont une fonctionnalité de liaison.
Merci.
Il semble que vous utilisiez un commentaire Javadoc lorsque vous appelez la méthode setNameText. Les commentaires Javadoc doivent être insérésci-dessusa déclaration de classe , a déclaration de méthode , ou a déclaration de champ .
Si vous voulez simplement un commentaire lorsque vous appelez la méthode, utilisez le commentaire sur une ligne: // get formatted name based on {@link FORMAT_NAME}.
Vous pouvez simplement le désactiver dans la page "Commentaire de fichier, de paramètres, de rédacteur en chef, d'inspections, de Java, de Javadoc".
Vous utilisez le format Javadoc qui commence par/** au lieu du format de commentaire de bloc qui commence par/*.
Pour atténuer cet avertissement, commencez toujours vos commentaires dans les méthodes avec/* pas/**.
Il suffit de remplacer "Dangling Javadoc Comment" par un commentaire de bloc.
Pour moi, il semble que le bon endroit pour ce commentaire se situe à côté de la méthode getFormattedName (), car votre commentaire explique les fonctionnalités de cette méthode et non la raison pour laquelle vous l'appelez.