Comment pouvez-vous échapper au caractère @ dans javadoc?
Comment puis-je échapper au symbole @ dans javadoc? J'essaie de l'utiliser dans une balise {@code}, qui est à l'intérieur des balises <pre>.
J'ai déjà essayé la séquence html escape @, mais cela n'a pas fonctionné.
4 answers
Utiliser le {@literal} je ne sais pas si c'est le cas.]}
/**
* 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 est la façon "officiellement prise en charge" d'afficher tous les caractères "spéciaux".
, Il est aussi le plus compliqué - vous n'avez pas besoin de connaître le code hexadécimal du caractère, et, vous pouvez lire ce que vous avez tapé!
Il suffit de l'écrire en tant qu'entité HTML:
@
Du document " javadoc-Le générateur de documentation de l'API Java "
Si vous voulez démarrer une ligne avec le caractère @ et ne pas l'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 en effet vous pouvez:
Le texte doit être écrit en HTML avec des entités HTML et des balises HTML. Vous pouvez utilisez 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 la 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 () doivent être écrites comme
<et>. De même, l'esperluette ( & ) doit s'écrire&.
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: @