Latest web development tutorials

Java documentazione Commenti

Java annotazioni solo tre tipi di modi. I primi due sono // e / * * /, e il terzo è chiamato il commento leggenda che inizia con / **, fine con * /.

Descrizione Commento consente di incorporare informazioni sul programma nel programma. È possibile utilizzare lo strumento javadoc per generare informazioni e l'uscita di file HTML.

Descrizione Commento, si registrano più informazioni per quanto riguarda il vostro programma.

tag javadoc

strumento javadoc riconosce i seguenti tag:

etichetta descrizione esempio
@author Identifica una classe di autori descrizione @author
@deprecated Nominato un membro della classe o scaduto descrizione @deprecated
{} @docRoot Percorso specificato nella directory corrente principale del documento Percorso directory
@exception Mark A eccezioni classe gettato @exception nome eccezione spiegazione
{} @inheritDoc Direttamente dal genitore classe eredita commento Eredita un commento dal surperclass immediato.
{@link} Inserimento di un collegamento a un altro argomento {Nome @link text}
{} @linkplain Inserisci un link a un altro argomento, ma il collegamento viene visualizzato in caratteri di testo normale Inserisce un collegamento in linea a un altro argomento.
@param Descrizione di un parametro di metodo @param parametro-name spiegazione
@return Tipo di ritorno Descrizione spiegazione @return
@see Specifica un link ad un altro argomento ancoraggio @see
@serial Una descrizione della sequenza di struttura descrizione @serial
@serialData Descrizione del metodo scritto da writeObject () e writeExternal () i dati descrizione @serialData
@serialField Una descrizione dei componenti ObjectStreamField @serialField descrizione del tipo nome
@SINCE Quando si introduce un marcatore specifico di cambiamento rilascio @SINCE
@throws E @exception stessa etichetta. Il tag @throws ha lo stesso significato come il tag @exception.
{} @value Valore visualizzato di una costante, la costante deve essere una proprietà statica. Mostra il valore di una costante, che deve essere un campo statico.
@Version La versione della classe specificata @Version informazioni

Commenti sulla documentazione

Dopo la partenza / **, la prima linea o le linee è la descrizione principale di classi, variabili e metodi.

Dopo di che, è possibile includere uno o più dei quali tipi di tag @. @ Ogni tag deve essere su una nuova linea, o cominciare all'inizio di una riga, seguito da un asterisco (*).

Una pluralità dello stesso tipo di etichetta deve essere posto in un gruppo. Ad esempio, se si dispone di tre tag @see, possono essere messi insieme uno per uno.

Quanto segue è una descrizione di un esempio di un commento classe: 

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

Cosa uscita javadoc

strumento Javadoc codice sorgente del programma Java in ingresso, in uscita alcuni file HTML contenente le annotazioni del programma.

Ogni tipo di informazione sarà solo nel file HTML. uscita javadoc può anche essere ereditata albero e indici.

A causa della diversa lavori di attuazione javadoc può essere diverso, è necessario controllare la versione del sistema di sviluppo Java e altri dettagli, selezionare la versione appropriata di Javadoc.

Esempi

Quanto segue è un commento che spiega l'uso di un semplice esempio. Si noti che il precedente progetto ogni annotazione nella sua descrizione.

Dopo il trattamento javadoc, note di classe SquareNum si trovano nella 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);
   }
}

Come segue, utilizzando lo strumento javadoc per elaborare file di 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
$