Comment échapper au caractère @ en javadoc?
Comment puis-je échapper au @ symbole en javadoc? J'essaie de l'utiliser dans un {@code} tag, qui est à l'intérieur <pre> Mots clés.
J'ai déjà essayé l'évasion html @ séquence, mais cela n'a pas fonctionné.
Utilisez le {@literal} balise javadoc:
/**
* This is an "at" symbol: {@literal @}
*/
Le javadoc pour cela se lira:
This is an "at" symbol: @
Bien sûr, cela fonctionnera pour tous les caractères , et c'est la façon "officiellement prise en charge" d'afficher tous les caractères "spéciaux".
C'est aussi le plus simple - vous n'avez pas besoin de connaître le code hexadécimal du personnage, et vous pouvez lire ce que vous avez tapé!
Il suffit de l'écrire en tant qu'entité HTML:
@
Du document " javadoc - Le Java API Documentation Generator "
Si vous voulez commencer une ligne avec le caractère @ et ne pas la faire interpréter, utilisez l'entité HTML @.
Cela implique que vous pouvez utiliser des entités HTML pour tout caractère que vous auriez besoin d'échapper, et vous pouvez en effet:
Le texte doit être écrit en HTML avec des entités HTML et des balises HTML. Vous pouvez utiliser n'importe quelle version de HTML prise en charge par votre navigateur. Le doclet standard génère du code compatible HTML 3.2 ailleurs (en dehors des commentaires de documentation) avec l'inclusion de feuilles de style et de cadres en cascade. HTML 4.0 est préféré pour les fichiers générés en raison des jeux de cadres.
Par exemple, les entités pour le symbole inférieur à (<) et le symbole supérieur à (>) doivent être écrites comme
<et>. De même, l'esperluette (&) doit être écrite comme&.
ma solution est
/**
* Mapper Test Helper.
*
* add the following annotations above the class
* <pre>{@code
* // junit5
* @literal @ExtendWith(SpringExtension.class)
* // junit4
* @literal @RunWith(SpringRunner.class)
* }</pre>
*/
Vous avez l'idée générale, essayez d'utiliser la représentation octale: @