all - ¿Cómo se puede escapar del carácter @ en javadoc?

javadoc netbeans

Question

¿Cómo puedo escapar del símbolo @ en javadoc? Intento usarlo dentro de una etiqueta {@code} , que está dentro de <pre> etiquetas <pre> .

Ya probé el escape html @ secuencia, pero eso no funcionó.

Answer 1

Simplemente escríbelo como una entidad HTML:

@

Del documento " javadoc - El generador de documentación de API de Java "

Si desea comenzar una línea con el carácter @ y no hacer que se interprete, use la entidad HTML @.

Esto implica que puede usar entidades HTML para cualquier personaje que necesite para escapar, y de hecho puede:

El texto debe estar escrito en HTML con entidades HTML y etiquetas HTML. Puede usar cualquier versión de HTML compatible con su navegador. El doclet estándar genera código compatible con HTML 3.2 en otro lugar (fuera de los comentarios de la documentación) con la inclusión de cuadros y hojas de estilo en cascada. HTML 4.0 es preferido para los archivos generados debido a los conjuntos de marcos.

Por ejemplo, las entidades para el menor que el símbolo (<) y el mayor que el símbolo (>) deben escribirse como < y > . Del mismo modo, el signo de & (y) debe escribirse como & .

Answer 2

Tienes la idea general, intenta usar la representación octal: @

Answer 3

Usa la {@literal} javadoc:

/**
 * This is an "at" symbol: {@literal @}
 */

El javadoc para esto leerá:

This is an "at" symbol: @

Por supuesto, esto funcionará para cualquier personaje, y es la forma "oficialmente admitida" de mostrar cualquier carácter "especial".

También es el más directo: no necesitas saber el código hexadecimal del personaje, ¡ y puedes leer lo que has escrito!

Answer 4

mi solución es

/**
 * Mapper Test Helper.
 *
 * add the following annotations above the class
 * <pre>{@code
 * // junit5
 * @literal @ExtendWith(SpringExtension.class)
 * // junit4
 * @literal @RunWith(SpringRunner.class)
 * }</pre>
 */