Latest web development tutorials

Java Documentación Comentarios

Java anotaciones sólo tres tipos de formas. Los dos primeros son // y / * * /, y el tercero se llama el comentario leyenda que comienza con / **, terminan con * /.

Descripción Comentario le permite incluir información sobre el programa en el programa. Puede utilizar la herramienta javadoc para generar información y la salida a archivos HTML.

Descripción Comentario, se graban más información con respecto a su programa.


etiqueta Javadoc

la herramienta javadoc reconoce las siguientes etiquetas:

etiqueta descripción ejemplo
@author Identifica una clase de autores Descripción @author
@deprecated Nombrado miembro de la clase o caducado Descripción @deprecated
{} @docRoot Ruta especificada en el directorio raíz del documento actual Ruta del directorio
@exception Marcar una clase excepciones lanzadas @exception excepción en nombre de explicación
{} @inheritDoc Directamente del padre clase hereda comentario Hereda un comentario de la surperclass inmediata.
{} @link Inserción de un enlace a otro tema {@ Link de texto Nombre}
{} @linkplain Insertar un enlace a otro tema, pero el vínculo se muestra en la fuente de texto sin formato Inserta un enlace en línea a otro tema.
@param Descripción de un parámetro del método @param nombre-parámetro explicación
@return Tipo devuelto Descripción explicación @return
@see Especifica un enlace a otro tema ancla @see
@serial Una descripción de la secuencia de la propiedad Descripción @serial
@serialData Descripción del método escrito por writeObject () y writeExternal () de datos Descripción @serialData
@serialField Una descripción de los componentes ObjectStreamField @serialField descripción del tipo de nombre
@since Cuando la introducción de un marcador específico de cambio liberación @since
@throws Y @exception misma etiqueta. La etiqueta @throws tiene el mismo significado que la etiqueta @exception.
{} @value Indicación del valor de una constante, la constante debe ser una propiedad estática. Muestra el valor de una constante, que debe ser un campo estático.
@version Versión de la clase especificada @version información

documentación Comentarios

Después de la salida / **, la primera línea o líneas es la descripción principal de clases, variables y métodos.

Después de eso, se pueden incluir uno o más de qué tipo de etiqueta @. @ Cada etiqueta tiene que estar en una línea nueva, o comenzar por el principio de una línea seguido de un asterisco (*).

Una pluralidad del mismo tipo de etiqueta se coloque en un grupo. Por ejemplo, si tiene tres etiquetas @see, se pueden poner juntos uno por uno.

La siguiente es una descripción de un ejemplo de un comentario de la clase:

/*** This class draws a bar chart.
* @author Zara Ali
* @version 1.2
*/

Lo salida de javadoc

la herramienta javadoc código fuente de su programa Java como entrada, salida de algún archivo HTML que contiene las anotaciones del programa.

Cada tipo de información va a estar solo en el archivo HTML. javadoc de salida también puede ser heredada árbol y los índices.

Debido a los diferentes trabajos aplicación Javadoc puede ser diferente, es necesario comprobar la versión de su sistema de desarrollo de Java y otros detalles, seleccione la versión adecuada de Javadoc.

Ejemplos

El siguiente es un comentario que explica el uso de un sencillo ejemplo. Tenga en cuenta que el proyecto anterior cada anotación en su descripción.

Después del tratamiento javadoc, notas de clase SquareNum se pueden encontrar en el SquareNum.html.

import java.io.*;
 
/**
* This class demonstrates documentation comments.
* @author Ayan Amhed
* @version 1.2
*/
public class SquareNum {
   /**
   * This method returns the square of num.
   * This is a multiline description. You can use
   * as many lines as you like.
   * @param num The value to be squared.
   * @return num squared.
   */
   public double square(double num) {
      return num * num;
   }
   /**
   * This method inputs a number from the user.
   * @return The value input as a 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);
   }
}

En la siguiente manera, utilizando la herramienta javadoc para procesar archivos 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.
Generating package-frame.html...
Generating package-summary.html...
Generating package-tree.html...
Generating constant-values.html...
Building index for all the packages and classes...
Generating overview-tree.html...
Generating index-all.html...
Generating deprecated-list.html...
Building index for all classes...
Generating allclasses-frame.html...
Generating allclasses-noframe.html...
Generating index.html...
Generating help-doc.html...
Generating stylesheet.css...
1 warning
$