¿Cómo puedes escapar del carácter @ en javadoc?
¿ Cómo puedo escapar del @símbolo en javadoc? Estoy intentando usarlo dentro de una {@code}etiqueta, que está dentro de <pre>las etiquetas.
Ya probé la @secuencia de escape html, pero no funcionó.
Utilice la {@literal}etiqueta javadoc:
/**
* This is an "at" symbol: {@literal @}
*/
El javadoc para esto dirá:
This is an "at" symbol: @
Por supuesto, esto funcionará para cualquier carácter y es la forma "oficialmente admitida" de mostrar cualquier carácter "especial".
También es el más sencillo: no necesitas saber el código hexadecimal del carácter y puedes leer lo que has escrito.
Simplemente escríbalo como una entidad HTML:
@
Del documento " javadoc - El generador de documentación API de Java "
Si desea comenzar una línea con el carácter @ y que no se interprete, use la entidad HTML @.
Esto implica que puedes usar entidades HTML para cualquier carácter del que necesites escapar y, de hecho, puedes:
El texto debe estar escrito en HTML con entidades HTML y etiquetas HTML. Puede utilizar cualquier versión de HTML que admita su navegador. El doclet estándar genera código compatible con HTML 3.2 en otros lugares (fuera de los comentarios de la documentación) con la inclusión de marcos y hojas de estilo en cascada. Se prefiere HTML 4.0 para los archivos generados debido a los conjuntos de marcos.
Por ejemplo, las entidades para el símbolo menor que (<) y el símbolo mayor que (>) deben escribirse como
<y>. De manera similar, el signo comercial (&) debe escribirse como&.
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>
*/
