Elementos de Java

Elementos da Linguagem Java - Alessandro Cerqueira - 04/11/2011

Módulo III
Elementos da Linguagem Java
(Parte I)

Assuntos
Comandos
Tipos nativos
Palavras-reservadas

2

Elementos da Linguagem Java - Alessandro Cerqueira - 04/11/2011

Créditos
Autor
Prof. Alessandro Cerqueira
([e-mail])
Revisão
Professores da Escola de Ciência e Tecnologia
Universidade Unigranrio

3

Elementos da Linguagem Java - Alessandro Cerqueira - 04/11/2011

Tipos de Comentários
// Realiza o comentário do ponto onde está até o final
/* Realiza o comentário de bloco */
/** Realiza o comentário de documentação Javadoc */

da linha

• O comentário de documentação deve ser colocado antes de declarações, sendo utilizado pelo utilitário javadoc para a geração automática de arquivos de documentação no formato HTML.
• Requer o uso de tags como:
@param, return, throws,
@param, @return, @throws, etc.
• A documentação das classes que estaremos utilizando foram geradas a partir do Javadoc

4

Javadoc - Regras
Elementos da Linguagem Java - Alessandro Cerqueira - 04/11/2011

• Antes da declaração da classe deve-se colocar um devecomentário descrevendo o propósito da classe.
– @author
– @version

• Antes de cada atributo devemos colocar um comentário descrevendo os objetivos do atributo
• Antes de cada método devemos colocar um comentário descrevendo o seu propósito e uso
– Para cada parâmetro recebido adicionamos a tag @param
– Se houver retorno, adicionamos a tag @return
– Se o método dispara alguma exceção, inserimos a tag @throws

Elementos da Linguagem Java - Alessandro Cerqueira - 04/11/2011

5

Javadoc (Exemplo)
/**
* Esta é a documentação da classe ExemploJavadoc
* @author Alessandro Cerqueira
* @version 1.0
*/
public class ExemploJavadoc
{
/**
* Documentação do atributo a
*/
private int a;
/**
* Documentação do método mtd
* @param detalhes do parâmetro a
* @param detalhes do parâmetro s
*