Cómo cotizar & # 8220; * / & # 8221; en JavaDocs

Question

Necesito incluir * / en mi comentario JavaDoc. El problema es que esta es también la misma secuencia para cerrar un comentario. ¿Cuál es la forma correcta de citar / escapar de esto?

Ejemplo:

/**
 * Returns true if the specified string contains "*/".
 */
public boolean containsSpecialSequence(String str)

Seguimiento : Parece que puedo usar & amp; # 47; para la barra diagonal. El único inconveniente es que esto no es tan legible cuando se ve el código directamente en un editor de texto.

/**
 * Returns true if the specified string contains "*/".
 */

Answer 1

Utilice el escape HTML.

Entonces, en tu ejemplo:

/**
 * Returns true if the specified string contains "*/".
 */
public boolean containsSpecialSequence(String str)

& amp; # 47; se escapa como un " / " personaje.

Javadoc debería insertar la secuencia escapada sin molestar en el HTML que genera, y eso debería representarse como " * / " en tu navegador

Si quiere ser muy cuidadoso, puede escapar de ambos caracteres: & amp; # 42; & amp; # 47; se traduce en */

Edición :

  

Seguimiento: Parece que puedo usar & amp; # 47;   por el corte El único inconveniente es   que esto no es tan legible cuando   ver el código directamente.

Entonces? El punto no es que su código sea legible, el punto es que su código documentación sea legible. La mayoría de los comentarios Javadoc incorporan HTML complejo para su explicación. Demonios, el equivalente de C # ofrece una biblioteca completa de etiquetas XML. He visto algunas estructuras bastante intrincadas allí, déjame decirte.

Editar 2: Si le molesta demasiado, puede incrustar un comentario en línea que no sea javadoc que explique la codificación:

/**
 * Returns true if the specified string contains "*/".
 */
// returns true if the specified string contains "*/"
public boolean containsSpecialSequence(String str)

Answer 2

Nadie mencionó {@literal} . Esta es otra forma de hacerlo:

/**
 * Returns true if the specified string contains "*{@literal /}".
 */

Desafortunadamente no puede escapar de * / a la vez. Con algunos inconvenientes, esto también soluciona:

  

    

El único inconveniente es que esto no es tan legible cuando se ve el código directamente en un editor de texto.

  

Answer 3

/**
 * Returns true if the specified string contains "*/".
 */

Esta es la & # 8216; derecha & # 8217; solución, pero en aras de la legibilidad probablemente elegiría:

/**
 * Returns true if the string contains an asterisk followed by slash.
 */

Answer 4

Usar la entidad

*/ 

En su documentación aparecerá como " * / "

Answer 5

Te sugiero que también agregues un comentario de línea en algún lugar cerca de decir algo como

// */ is html for */

Answer 6

Otra forma en que me topé, solo para completar: agregue un marcado HTML que no altere la salida entre * y /.

  /**
   * *<b/>/
   */

En comparación con la solución de escape HTML, parece un truco feo, pero también produce el resultado correcto en la salida HTML.