Una lista de las etiquetas Javadoc

Javadoc, o "El Generador de documentación de la API de Java," genera páginas HTML que contienen documentación de la API de archivos fuente de Java. etiquetas Javadoc comprensión puede hacer que la programación con Javadoc un proceso simplificado, ya que su conocimiento de estas etiquetas le permitirá escribir código de forma rápida y eficiente. Existe un número de diferentes etiquetas Javadoc, cada uno específico para un determinado aspecto del código que permite la generación automática de una API de su código fuente.

Navegue a la lista de etiquetas Javadoc

Abra un navegador Web de su elección y vaya a la lista de etiquetas Javadoc en el sitio web de Oracle. En la parte superior de la página, se puede ver el enlace a las etiquetas Javadoc bajo la "Guía de referencia". La selección de este enlace le llevará a una lista de etiquetas Javadoc que están disponibles para su uso.

Notas importantes de sintaxis

La comprensión de la sintaxis de las etiquetas Javadoc es importante con el fin de ponerlas en práctica correctamente. etiquetas Javadoc comienzan con el signo "@" y también entre mayúsculas y minúsculas. Es importante que siga estas reglas de sintaxis cuando se trabaja con etiquetas Javadoc. Un ejemplo de una etiqueta Javadoc para el autor se vería de la siguiente manera:

@autor

Tenga en cuenta que la etiqueta comienza con el símbolo "@" y es todo en minúsculas, como es el caso en la lista proporcionada de etiquetas Javadoc.

Javadoc clave Etiquetas

Hay un número de etiquetas Javadoc que se puede utilizar en una amplia gama de aplicaciones. A continuación se presentan algunas etiquetas Javadoc clave y sus funciones:

@author - Esta etiqueta se utiliza para añadir una entrada autor. Puede tener varias etiquetas @author por documento, así como varios nombres por la etiqueta.

@see - Esta etiqueta se utiliza para crear un enlace que está definida por un #value URL. Ejemplo de sintaxis utilizando esta etiqueta es la siguiente:

@see <a href="test.html> </a> prueba

Esto generaría un enlace a la página de prueba, que se muestra como "prueba".

@version - Esta etiqueta se utiliza para mostrar el número de versión actual del software que se está programando.

Diferencia entre el bloque y Inline Etiquetas

Un punto importante en cuanto a etiquetas Javadoc es su colocación dentro del código. etiquetas de bloque sólo se pueden colocar en la sección de la etiqueta, que sigue la descripción principal. etiquetas en línea, por otro lado se pueden colocar en cualquier parte de la descripción principal y / o en los comentarios para etiquetas de bloque, y se indican en la lista de etiquetas por llaves ({} @tag). Es importante utilizar las etiquetas Javadoc en los lugares correctos.