¿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

código java opción doc

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

java

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

salida

Este es mi etiqueta:

hey ho ...

Answer 2

Bueno Lo que 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 una respuesta correcta se encuentra, espero que ayuda!

Answer 3

etiquetas personalizadas no se deben crear utilizando HTML porque javadoc podría cambiar su aplicación o la forma en que se presentan los datos, tal vez van a empezar a utilizar Markdown en el futuro , también el exportador Javadoc no detectará la información faltante y es posible que tenga "etiquetas" vacías.

Primera usar cualquier etiqueta que desee:

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

en cuenta que la etiqueta personalizada tiene el formato @[prefix].[tagName], esto se debe al hecho de que doclet (u otro plugin para 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 de doclet.

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

---

Ahora usted tiene que decir el exportador Javadoc acerca de 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 (el uso de "Siguiente" para cambiar las pantallas) debería ver esta pantalla:

usted debe notar que las "opciones Javadoc extra. ."Cuadro de texto tiene el valor debe agregar para el exportador Javadoc para crear el equivalente a HTML de su etiqueta

En nuestro caso, la opción es la siguiente (si desea que varias etiquetas, ponerlos en una nueva línea):.

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

Ahora, cuando se exporta el Javadoc (también recomiendo guardar una secuencia de comandos ANT por lo que no tiene que ir a través de este cuadro de diálogo cada vez) que tendrá su etiqueta personalizada en negrita con la descripción, y los valores por debajo

PD Todavía tengo que encontrar la manera de agregar la capacidad de agregar autocompletado para la c ustom tags, pero parece imposible en Indigo, tal vez será en versiones futuras (no estoy seguro si Juno lo tiene).

Answer 4

Si quiere múltiple, haga algo como javadoc -tag pre -tag post -tag invariant donde solicita argumentos de línea de comando. No utilice las cosas html