English | 简体中文 | 繁體中文 | Русский язык | Français | Español | Português | Deutsch | 日本語 | 한국어 | Italiano | بالعربية
Java admite tres formas de comentarios. Las dos primeras son // Y /* */Tercero se llama comentario explicativo, que se utiliza /** Comienzo, con */Finalizar.
Las notas de comentario permiten que insertes información sobre el programa en él. Puedes usar la herramienta javadoc para generar información y exportarla a archivos HTML.
Las notas de comentario describen, lo que te permite registrar información sobre tu programa de manera más conveniente.
La herramienta javadoc reconoce las siguientes etiquetas:
| Etiqueta | Descripción | Ejemplo |
|---|---|---|
| @author | Identificar al autor de una clase. | @author description |
| @deprecated | Especificar una clase o miembro obsoleto. | @deprecated description |
| {@docRoot} | Especificar la ruta del directorio raíz del documento actual. | Ruta del directorio |
| @exception | Marcar una excepción lanzada por una clase. | @exception exception-name explanation |
| {@inheritDoc} | Comentario heredado de la superclase inmediata. | Heredar un comentario del superclase inmediata. |
| {@link} | Insertar un enlace a otro tema. | {@link name text} |
| {@linkplain} | Insertar un enlace a otro tema, pero este enlace se muestra en fuente de texto puro. | Insertar un in-linea enlace a otro tema. |
| @param | Describir un parámetro de un método. | @param parameter-name explanation |
| @return | Describir el tipo de valor devuelto. | @return explanation |
| @see | Especificar un enlace a otro tema. | @see anchor |
| @serial | Describir una propiedad de serialización. | @serial description |
| @serialData | Describir los datos escritos a través de los métodos writeObject( ) y writeExternal( ). | @serialData description |
| @serialField | Describir un componente ObjectStreamField. | @serialField name type description |
| @since | Marcar cuando se introduce un cambio específico. | @since release |
| @throws | Igual que la etiqueta @exception. | La etiqueta @throws tiene el mismo significado que la etiqueta @exception. |
| {@value} | Mostrar el valor de la constante, que debe ser una propiedad estática. | Muestra el valor de una constante, que debe ser un campo estático. |
| @version | especifica la versión de la clase | @version info |
en el principio /** después, la primera o primeras líneas son una descripción principal de la clase, variable y método.
después, puede incluir una o más de varias clases de @ etiquetas. Cada @ las etiquetas deben comenzar en una nueva línea o al inicio de una línea seguidas de un asterisco (*).
Las etiquetas del mismo tipo deben estar agrupadas. Por ejemplo, si tiene tres @see etiquetas, puede ponerlas una detrás de otra.
A continuación, se muestra un ejemplo de comentario de clase:
/*** Esta clase dibuja un gráfico de barras * @author w3codebox * @version 1.2 */
La herramienta javadoc toma el código fuente de su programa Java como entrada y produce algunos archivos HTML que contienen los comentarios de su programa.
La información de cada clase estará en un archivo HTML independiente. javadoc también puede generar una estructura de árbol de herencia e índice.
Dado que la implementación de javadoc puede variar, el trabajo también puede variar. Necesita verificar la versión de su sistema de desarrollo Java y otros detalles para seleccionar la versión adecuada de Javadoc.
A continuación, se muestra un ejemplo simple de comentario de uso. Nota que cada comentario está antes del proyecto que describe.
Después del procesamiento de javadoc, los comentarios de la clase SquareNum se encontrarán en SquareNum.html.
import java.io.*;
/**
* Esta clase muestra comentarios de documentación
* @author Ayan Amhed
* @version 1.2
*/
public class SquareNum {
/**
* Este método devuelve el cuadrado de num.
* Esta es una descripción multilinea. Puede usar
* tantas líneas como desee.
* @param num El valor que se debe cuadrar.
* @return El cuadrado de num.
*/
public double square(double num) {
return num * num;
}
/**
* Este método recibe un número del usuario.
* @return El valor de entrada como un double.
* @exception IOException On input error.
* @see IOException
*/
public double getNumber() throws IOException {}}
InputStreamReader isr = new InputStreamReader(System.in);
BufferedReader inData = new BufferedReader(isr);
String str;
str = inData.readLine();
return (new Double(str)).doubleValue();
}
/**
* This method demonstrates square().
* @param args Unused.
* @return Nothing.
* @exception IOException On input error.
* @see IOException
*/
public static void main(String args[]) throws IOException
{
SquareNum ob = new SquareNum();
double val;
System.out.println("Enter value to be squared: ")
val = ob.getNumber();
val = ob.square(val);
System.out.println("Squared value is ") + val);
}
}如下，使用 javadoc 工具处理 SquareNum.java 文件：
$ javadoc SquareNum.java Loading source file SquareNum.java... Constructing Javadoc information... Standard Doclet version 1.5.0_13 Building tree for all the packages and classes... Generating SquareNum.html... SquareNum.java:39: warning - @return tag cannot be used\ in method with void return type. Generando paquete-frame.html... Generando paquete-summary.html... Generando paquete-tree.html... Generando constante-values.html... Construyendo índice para todos los paquetes y clases... Generando resumen-tree.html... Generando índice-all.html... Generando deprecated-list.html... Construyendo índice para todas las clases... Generando allclasses-frame.html... Generando allclasses-noframe.html... Generando index.html... Generando ayuda-doc.html... Generando stylesheet.css... 1 aviso $