Skip to content

2.1.8 Convenções de Nomes

Tomaz Martins edited this page Jul 30, 2015 · 5 revisions

Convenção de Nomes

Identificador Regras de Nome Exemplo
Pacotes Os prefixos do pacote devem seguir os mostrados na tabela Convenção de Prefixos. O sufixo do nome do pacote deve ser sempre em letras minúsculas br.com.visualize.api.dao
Classes Os nomes de classe devem ser substantivos, em upper camel case. Tente manter seus nomes de classe simples e descritivos. Use palavras completas - evitar siglas e abreviaturas (a não ser que a sigla seja muito mais usada do que a forma longa, como URL ou HTML). class Quota;
Interfaces Nomes de interface devem ser escritos como nomes de class. interface Storing;
Métodos Os nomes de métodos devem ser iniciados com um verbo e escritos utilizando lower camel case. run()
Variáveis Os nomes de variáveis devem ser substantivos e escritos utilizando lower camel case. Os nomes das variáveis não devem começar com underscore _ ou sinal de dólar $, mesmo que ambos sejam permitidos pela linguagem Java. Os nomes das variáveis devem ser curtos, mas significativos. Nomes de variáveis de um caractere devem ser evitados, exceto os nomes i , j e k em seus locais usuais como o for. int i;
Constantes Os nomes de variáveis constantes devem possuir todas as letras maiúsculas com palavras separadas por underscore. static final int CAR = 1;

Convenção de Prefixos de Pacotes

Prefixos de Pacote Descrição o Pacote
br.com.visualize.akan.api.dao Pacote responsável por envolver classes destinadas à comunicação com o banco de dados.
br.com.visualize.akan.api.helper Pacote responsável por envolver classes destinadas ao auxílio no tratamento de estruturas complexas, como Json.
br.com.visualize.akan.api.request Pacote responsável por envolver classes responsáveis pelas requisições ao servidor.
br.com.visualize.akan.domain.adapters Pacote responsável por envolver classes para adaptação de views.
br.com.visualize.akan.domain.controller Pacote responsável por envolver classes controladoras.
br.com.visualize.akan.domain.enumeration Pacote responsável por envolver enumerações.
br.com.visualize.akan.domain.exception Pacote responsável por envolver classes que representam exceções.
br.com.visualize.akan.domain.model Pacote responsável por envolver classes que representem o domínio do negócio.
br.com.visualize.akan.domain.view Pacote responsável por envolver classes que farão a interação com o usuário da aplicação.