que - javadoc wiki

¿Cómo crear etiquetas javadoc personalizadas?

Question

¿Cómo creo etiquetas javadoc personalizadas como @pre / @post? Encontré algunos enlaces que lo explican, pero no he tenido suerte con ellos. Estos son algunos de los enlaces:

http://www.developer.com/java/other/article.php/3085991/Javadoc-Programming.html

http://java.sun.com/j2se/1.5.0/docs/tooldocs/windows/javadoc.html

Answer 1

Bueno, lo que hice no es la mejor solución pero es legible:

  /** <p><b>Pre:</b></p>  <Ul>True</Ul>
    * <p><b>Post:</b></p> <Ul>The x is pushed onto the top of the stack,
    *                       and the rest of the stack remains unchanged.</Ul>
    *
    * @param x              Indicates the current node
    */
   public void push(int x){
      ...
   }

Hasta que se encuentre una respuesta adecuada, espero que ayude!

Answer 2

Las etiquetas personalizadas no deben crearse usando HTML porque javadoc puede cambiar su implementación o la forma en que presenta los datos, tal vez comiencen a usar Markdown en el futuro, además, el exportador de Javadoc no detectará la información que falta y es posible que tenga "etiquetas" vacías.

Primero usa la etiqueta que quieras:

/**
 * Comments and a {@link #methodLink} for this method.
 * 
 * @tt.wrapper {@link OtherClass}
 *
 */
public String extractName() {
    // method contents
}

Tenga en cuenta que la etiqueta personalizada tiene el formato @[prefix].[tagName] , esto se debe al hecho de que doclet (u otro complemento de Eclipse) podría lanzar su propia etiqueta con el mismo nombre, y su etiqueta simplemente anularía la etiqueta estándar , por lo que agregamos un prefijo para que sea menos probable que eso suceda.

Comentario del doclet.

Etiquetas personalizadas que podrían anular futuras etiquetas estándar: @wrapper Para evitar posibles anulaciones, use al menos un carácter de punto (.) En los nombres de etiquetas personalizadas.

Ahora tiene que decirle al exportador Javadoc sobre esta etiqueta personalizada, @tt.wrapper . Vaya a Project > Generate Javadoc.. en Eclipse (Indigo en mi caso).

Después de configurar los ajustes para las dos primeras pantallas de este cuadro de diálogo (usando "Siguiente" para cambiar las pantallas) debería ver esta pantalla:

Debe observar que el cuadro de texto "Opciones extra de Javadoc ..." tiene el valor que debe agregar para que el exportador Javadoc cree el equivalente HTML de su etiqueta.

En nuestro caso, la opción es esta (si desea varias etiquetas, colóquelas en una nueva línea):

-tag tt.wrapper:a:"API Wrapper:"

Ahora, cuando exporte su Javadoc (también recomiendo guardar una secuencia de comandos ANT para que no tenga que pasar por este diálogo cada vez) tendrá su etiqueta personalizada en negrita con la descripción y los valores debajo.

PD: aún tengo que encontrar una manera de agregar la capacidad de agregar autocompletado para las etiquetas personalizadas, pero parece imposible en Indigo, tal vez lo esté en futuras versiones (no estoy seguro de si Juno lo tiene).

Answer 3

Si quieres varios, haz algo como javadoc -tag pre -tag post -tag invariant donde pide argumentos de línea de comando. No uses las cosas html

Answer 4

código java

/**
 * @custom.mytag hey ho...
 */

opción de documento java

-tag custom.mytag:a:"This is my Tag:"

salida

Esta es mi etiqueta:

hey ho ...