-
Notifications
You must be signed in to change notification settings - Fork 2
2.1.2 Organização de Arquivos
Cada arquivo fonte Java deve conter apenas uma classe, ou interface, pública. Quando uma classe e/ou interface privada estiver associada a uma classe pública, pode- se colocá-la no mesmo arquivo que a classe pública. A classe, ou interface, pública deve ser a primeira coisa visível no arquivo. Arquivos fonte Java devem seguir a seguinte ordem de organização:
- Comentários Iniciais.
- Instruções de pacotes e importação.
- Declaração de classe ou interface.
Todo arquivo fonte deve iniciar com um comentário ao estilo C, que liste o nome da classe, ou interface e seu propósito. Segue um exemplo:
/*
* File: ExampleClass
* Purpose: This os a example for explain how to write a beginning comment.
*/A primeira linha do arquivo que não seja um comentário deve ser uma instrução de pacote. Feito isso, segue-se as instruções de importação. Exemplo:
package br.com.visualize.akan.domain.controller;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import org.apache.http.client.ResponseHandler;
import org.json.JSONException;
import android.content.Context;
import android.util.Log;
import br.com.visualize.akan.api.dao.CongressmanDao;
import br.com.visualize.akan.api.helper.JsonHelper;
import br.com.visualize.akan.api.request.HttpConnection;
import br.com.visualize.akan.domain.enumeration.Order;
import br.com.visualize.akan.domain.exception.ConnectionFailedException;
import br.com.visualize.akan.domain.exception.DatabaseInvalidOperationException;
import br.com.visualize.akan.domain.exception.NullCongressmanException;
import br.com.visualize.akan.domain.exception.NullQuotaException;
import br.com.visualize.akan.domain.model.Congressman;
import br.com.visualize.akan.domain.model.Quota;A tabela que se segue descreve as partes de uma declaração de classe ou interface. Essas partes devem aparecer na ordem em que são apresentadas na tabela.
| Ordem | Parte da Classe/Interface | Descrição |
|---|---|---|
| 1 | Comentários de Documentação da Classe/Interface | Ver Seção sobre Comentários de Documentação |
| 2 | Instrução class ou interface
|
- |
| 3 | Comentários de Implementação da Classe/Interface | Este comentário contém qualquer informação sobre a Classe/Interface que não for apropriado ao comentário de Documentação. |
| 4 | Variáveis static da classe |
Primeiro as variáveis public, seguidas das variáveis protected. Depois as variáveis private. |
| 5 | Variáveis de Instância da Classe. | Primeiro as variáveis public, seguidas das variáveis protected. Depois as variáveis private. |
| 6 | Construtores | - |
| 7 | Comentários de Documentação de Método | Ver Seção sobre Comentários de Documentação |
| 8 | Métodos | Primeiro os métodos public, seguidos dos métodos protected. Depois os métodos private. |