Latest web development tutorials

Documentação de Java Comentários

Java anotações apenas três tipos de formas. Os dois primeiros são // e / * * /, eo terceiro é chamado o comentário legenda que começa com / **, terminam com * /.

Descrição Comentário permite embutir informações sobre o programa no programa. Você pode usar a ferramenta javadoc para gerar informações e saída para arquivos HTML.

Descrição Comentário, você gravar mais informações sobre o seu programa.

tag javadoc

ferramenta javadoc reconhece as seguintes tags:

etiqueta descrição exemplo
@author Identifica uma classe de autores A inscrição @author
@deprecated Nomeado um membro da classe ou expirado A inscrição @deprecated
{@docRoot} Caminho especificado no diretório atual raiz do documento Caminho do Diretório
@exception Mark A exceções de classe jogados @exception exceção em nome explicação
{@inheritDoc} Diretamente do pai classe herda comentário Herda um comentário do surperclass imediata.
{@link} Inserir um link para outro tópico {Text Nome @link}
{@linkplain} Inserir um link para outro tópico, mas o link é exibido em fonte de texto simples Insere uma ligação em linha para outro tópico.
@param Descrição de um método de parâmetro @param parâmetro de nome explicação
@return Tipo de retorno Descrição explicação @return
@see Especifica um link para outro tópico âncora @see
@serial A descrição da sequência da propriedade A inscrição @serial
@serialData Descrição Método escrito por writeObject () e writeExternal () de dados A inscrição @serialData
@serialField A descrição dos componentes ObjectStreamField @serialField descrição nome de tipo
@since Quando da introdução de um marcador específico de mudança liberação @since
@throws E @exception mesmo rótulo. O tag @throws tem o mesmo significado que o tag @exception.
{@value} valor de exibição de uma constante, a constante deve ser uma propriedade estática. Exibe o valor de uma constante, que deve ser um campo estático.
@version Versão da classe especificada @version Informação

documentação Comments

Após o início / **, a primeira linha ou linhas é a principal descrição das classes, variáveis ​​e métodos.

Depois disso, você pode incluir um ou mais do que os tipos de @ tag. @ Cada etiqueta deve estar numa nova linha, ou começar no início de uma linha seguida por um asterisco (*).

Uma pluralidade do mesmo tipo de etiqueta deve ser colocada num grupo. Por exemplo, se você tem três tags @see, eles podem ser colocados juntos, um por um.

O que se segue é a descrição de um exemplo de um comentário de classe: 

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

Qual a saída javadoc

ferramenta javadoc código-fonte do seu programa Java como entrada, saída de algum arquivo HTML contendo as anotações do programa.

Cada tipo de informação estará sozinho no arquivo HTML. saída javadoc também pode ser herdada árvore e índices.

Devido aos diferentes javadoc trabalho de implementação pode ser diferente, é preciso verificar a versão do seu sistema de desenvolvimento Java e outros detalhes, selecione a versão apropriada do Javadoc.

Exemplos

O que se segue é um comentário que explica o uso de um exemplo simples. Note que o projeto anterior de cada anotação em sua descrição.

Após o tratamento javadoc, SquareNum notas de aula será encontrado na 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);
   }
}

Como se segue, utilizando a ferramenta javadoc para processar arquivo 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
$