@param
La etiqueta @param puede archivar un solo parámetro de un método o constructor, o escribir parámetros de una clase de archivo, interfaz y métodos genéricos. Al usar la etiqueta @param, debemos usar una de las etiquetas para cada parámetro del método. La primera palabra en cada párrafo se considerará como un nombre de parámetro, mientras que el resto será considerado como una descripción:
@param max El número máximo de palabras para leer.
Al archivar los parámetros de tipo, debemos agregar <y> a ambos lados del nombre de parámetro de tipo:
@param 体中国中国中国中国
Sin embargo, los parámetros de tipo generalmente no requieren documentación explícita, ya que todos son muy obvios.
@ ver
Las etiquetas de @See pueden crear referencias cruzadas vinculadas a otros documentos Javadoc. Podemos nombrar cualquier identificador después de la etiqueta, aunque debemos calificarlos por completo. Por ejemplo, generalmente se puede nombrar con un nombre simple de un miembro de una clase, pero si el miembro es un método sobrecargado, debemos especificar la versión sobrecargada del método enumerando los tipos de cada parámetro. Podemos usar un nombre no calificado para especificar la interfaz o clase dentro del paquete actual, pero debemos usar un nombre completamente calificado para especificar los tipos en otros paquetes. Podemos especificar miembros del tipo usando # antes del nombre del miembro. Aquí hay todos válidos @ ver formatos de etiqueta:
@see #getname @see attr @see com.magic.attr.attr @see com.magic.attr.deck#mazo-size @see com.magic.attr.attr#getName @see com.magic.attr.attr#attr (string) @see com.magic.attr.attr#attr (string) @seeee Objeto) @see com.magic.attr @see especificación de atributo @see "The Java Developer's Almanac"
La primera forma se refiere a un método llamado GetName, que se encuentra en la misma clase o interfaz que la anotación de documentos en sí, o en una determinada clase circundante o interfaz circundante. Dicha sintaxis también se puede aplicar a constructores y campos. El segundo formulario se refiere a la clase en el paquete actual o en la clase en un paquete de guía determinado. El tercer formulario se refiere a una clase utilizando un nombre totalmente calificado.
Las últimas 4 formas de @See se refieren a los miembros, donde los dos primeros son sobre dominios (Deck-Siz Day and Method (getName). Podemos usar el nombre del método directamente porque solo se define un método GetName en la clase ATTT. Los dos últimos formularios se refieren al constructor de la clase ATTR, una de las cuales acepta las cotizaciones de cadenas y el otro que acepta estrucciones y objetos cuando el constructo o el método de construcción tiene un Método Overloaded. Citas a las que queremos referirnos.
El siguiente formulario @see lleva al lector a un paquete específico: com.magic.attro
Las dos últimas formas nos permiten citar otros documentos. Entre ellos, el anterior usa para definir el enlace, y este último usa citas para encerrar el nombre del documento. Podemos usar ambos formularios para dirigir al lector a otros documentos, como el manual completo.
El formulario @See (todos los formularios excepto los dos últimos formularios anteriores) que nombran la entidad del lenguaje puede ser seguido por una etiqueta. En el documento generado, este nombre de la etiqueta reemplazará el nombre de la entidad. Por ejemplo:
@ ver #getNameAttribute Nombres
Se creará un enlace al documento de GetName, pero el texto que muestra es "Nombres de atributos" en lugar de "GetName". Por lo general, debemos usar los nombres reales de los miembros, pero las características que se muestran aquí ocasionalmente son útiles.