Supongamos que tengo una interfaz de la siguiente manera.
public interface MyInterface{
/**
* This method prints hello
*/
void sayHello();
/**
* This method prints goodbye
*/
void sayGoodBye();
}
Una clase concreta implementa estos métodos. Ahora, ¿los métodos en la clase concreta también necesitan definir los javadocs además de su definición de método? Veo que algunas personas simplemente copian la misma definición de javadoc en los métodos implementados de la clase concreta. No veo esto como una buena práctica porque si vamos a cambiar la definición de documento, necesitamos cambiarla en varios lugares.
¿Cuál es la práctica estándar para esto?
Puede usar {@inheritDoc}para heredar la documentación de la interfaz y simplemente agregar comentarios adicionales si cree que son información adicional significativa y relevante para la implementación específica.
Solo use @inheritDoc si tiene la intención de agregar a la documentación original de la superclase / interfaz . Si solo quiere una copia, Javadoc se encargará de eso. Verá que la documentación de la superclase se aplica al método anulado de la subclase porque la subclase no proporcionó documentación adicional.
{@inheritDoc}- Hereda (copia) documentación de la clase heredable o interfaz implementable "más cercana" en el comentario de documento actual en la ubicación de esta etiqueta. Esto le permite escribir comentarios más generales en una parte superior del árbol de herencia y escribir alrededor del texto copiado.
http://docs.oracle.com/javase/6/docs/technotes/tools/solaris/javadoc.html#@inheritDoc
Este artículo se recopila de Internet, indique la fuente cuando se vuelva a imprimir.
En caso de infracción, por favor [email protected] Eliminar
Déjame decir algunas palabras