Que fait l'annotation @code java
J'ai essayé de chercher par le biais de la documentation Oracle pour une explication de ce que l'
@code
java annotation n'.
À partir d'une précédente question, j'ai réalisé qu'il a quelque chose à voir avec le html, mais je ne suis pas sûr exactement ce que...
Serait-il correct de dire que, par défaut, javadoc est analysée comme du HTML...
Mais la pose de la @code
annotation à côté de certains javadoc texte indique qu'il doit être traité comme code, et non analysé/rendu de la manière habituelle?
Ainsi, par exemple:
/**
*This is how to declare an int variable {@code int var=1;}
*/
Ça serait un bon exemple de son utilisation?
source d'informationauteur JMS
Vous devez vous connecter pour publier un commentaire.
{@code }
est une balise Javadoc qui raconte Javadoc que le texte à l'intérieur de l'appareil est code et ne doit pas être traité comme du HTML. Javadoc devrait également mettre en forme le texte dans un bloc de code différemment que l'autre texte. Ceci est très similaire concept du "code échantillon" du texte que l'éditeur de StackOverflow utilise lorsque vous formatez une question ou une réponse.Si vous voulez ajouter de la documentation Javadoc pour une méthode.
Peut-être que vous ne savez pas ce que sont les Javadocs
Donc la chose en jaune est une Javadoc ici
Si vous voulez ajouter du code pour une méthode comme une Javadoc, alors vous pouvez l'annoter avec
@code
pour les autres à l'aide de la méthode pour voir la méthode comme un exemple.et pourquoi nous avons besoin de l'utiliser parce que si nous ne le faisons pas alors la mise en forme ne sera pas bon
Vous pouvez vous référer à la question suivante si vous voulez vérifier les modifications de mise en forme que prennent place si vous n'ajoutez pas de
@code
: Plusieurs ligne de code exemple dans le commentaire Javadoc