Pregunta Javadoc: ¿cómo copiar la descripción de la función?


Tengo dos funciones de Java:

/**
* Do something with param
*/
public String doSomething(String param) {...};

/**
* ...
*/
public String doSomething(Integer param) {...};

¿Cómo puedo hacer la descripción de la segunda función para mostrar una copia exacta de la primera función?


17
2018-03-30 09:17


origen


Respuestas:


Suponiendo que copiar y pegar no funcionará para usted, creo que la convención es usar la etiqueta @see para referirse a otro método que proporcionará más detalles.

En su ejemplo, doSomething (Integer param) tendría una etiqueta @see que hace referencia a la versión String.

Wikipedia tiene algunos ejemplos, http://en.wikipedia.org/wiki/Javadoc

Al igual que el sitio de Oracle para la herramienta javadoc http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html#multiple@see


20
2018-03-30 09:20



La respuesta corta es que no puedes. La costumbre es hacer uso de la @see directiva o simplemente copiar pegar.

Si está creando una subclase, puede colocar javadoc en el nivel de interfaz para lograr lo que desea.


9
2018-03-30 09:18



Como dos métodos con diferentes tipos de params no pueden tener la misma descripción. Pero para el método heredado, podemos usar la misma descripción.

método heredado

Para el método heredado puede usar

{@inheritDoc}

Copia la descripción del método reemplazado.


6
2018-03-30 09:36



No quieres hacer eso. Quieres el segundo para referir a la primera. Para eso es @see. Nunca desea repetir la documentación, por la misma razón que su segundo método llama al primer método en lugar de contener una copia de su código.


2
2018-03-30 23:50