Comment puis-je échapper au @
symbole dans javadoc? J'essaie de l'utiliser dans une {@code}
balise, qui se trouve à l'intérieur des <pre>
balises.
J'ai déjà essayé la @
séquence d' échappement html , mais cela n'a pas fonctionné.
Comment puis-je échapper au @
symbole dans javadoc? J'essaie de l'utiliser dans une {@code}
balise, qui se trouve à l'intérieur des <pre>
balises.
J'ai déjà essayé la @
séquence d' échappement html , mais cela n'a pas fonctionné.
Réponses:
Utilisez la {@literal}
balise javadoc:
/**
* This is an "at" symbol: {@literal @}
*/
Le javadoc pour cela lira:
This is an "at" symbol: @
Bien sûr, cela fonctionnera pour tous les caractères, et c'est la manière "officiellement prise en charge" d'afficher les caractères "spéciaux".
C'est aussi le plus simple - vous n'avez pas besoin de connaître le code hexadécimal du caractère, et vous pouvez lire ce que vous avez tapé!
}
symbole?
}
n'a pas de signification particulière en html.
literal
balises.
{
et simplement utiliser @literal @
fonctionne à l'intérieur d'une {@code}
balise.
Écrivez-le simplement comme une entité HTML:
@
Depuis le document " javadoc - Le générateur de documentation de l'API Java "
Si vous souhaitez 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 dont vous auriez besoin pour é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 la version 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érable 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 sous la forme
<
et>
. De même, l'esperluette (&) doit être écrite sous la forme&
.
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: @
@
a le point de code 0x40 en hexadécimal, qui est 64 en décimal
Une approche alternative de https://stackoverflow.com/a/46332643/208581 ... consiste à utiliser un caractère similaire mais différent plutôt que d'échapper au caractère: (Cette réponse est copiée de la réponse source)
Une façon de contourner ce problème est d'utiliser un caractère différent qui ressemble au symbole standard "@".
Être similaire mais différent de