Saltar al contenido

¿Qué etiqueta debería usarse como separador de párrafos en Javadoc?

Solución:

Bienvenido a la tierra de HTML 3.2.

De acuerdo con la guía oficial sobre cómo escribir comentarios de documentos, la forma correcta de separar párrafos es con la etiqueta de párrafo: <P>. Eche un vistazo a la séptima viñeta en la sección sobre Formato de un comentario de documento.

Por lo general, recomendaría encarecidamente no utilizar prácticas tan antiguas y obsoletas para el marcado. Sin embargo, en este caso, hay una buena razón para hacer una excepción. La herramienta Javadoc (a menos que se actualice radicalmente con Doclets personalizados) genera un marcado antiguo, tosco y algo roto. Los navegadores se han creado para ser compatibles con las versiones anteriores del loco y antiguo marcado del día, por lo que tiene sentido que lo aceptes. Tu uso de <P> separar párrafos estará en línea con el resto de la salida de Javadoc.

Estrictamente hablando, un autocierre <p /> no tiene sentido, ya que <p> debería ser usado para Contiene un párrafo, es decir, el párrafo debe estar encerrado por <p> y </p>.

<br> sin embargo, es una etiqueta de “nivel inferior” que indica un salto de línea. Entonces, la forma semánticamente correcta de indicar párrafos sería usar <p>:

<p>This Foo is used to frobincate a {@link Baz}.</p>
<p>It is quite groovy!</p>

vs.

This Foo is used to frobincate a {@link Baz}.<br>
It is quite groovy!

Visualmente el <p> da como resultado más espacios en blanco entre las líneas, mientras que un <br> simplemente comenzará una nueva línea y no introducirá ningún espacio en blanco importante.

Con Java 8, un solo elemento inicial (<p>) obras.

Tenga en cuenta que a javadoc no le gusta el elemento de cierre (</p>).

¡Haz clic para puntuar esta entrada!
(Votos: 0 Promedio: 0)



Utiliza Nuestro Buscador

Deja una respuesta

Tu dirección de correo electrónico no será publicada. Los campos obligatorios están marcados con *