Convenes de Nomenclatura

NOMENCLATURA GERAL
- O nome deve refletir exatamente o objeto que ele representa e suas funes;
- Busque sempre escolher um nome intuitivo e de fcil entendimento;
- Deve-se evitar o uso de siglas e abreviaes, caso necessrio use as conhecidas;
- O nome deve ser definido sempre com letras minsculas e no singular;
- No utilize acentuaes ou caracteres especiais;
- Todas as palavras e prefixos que compe o nome devem ser separados por _
(underline);
- Deve-se evitar o uso de nmeros e preposies;
- Preferencialmente fazer as declaraes em Ingls;

Classes
Nomes de classes devem conter somente caracteres alfanumricos. Nmeros so
permitidos em nomes de classes mas so desencorajados na maioria dos casos.
Underscores so permitidos somente no lugar de separador de diretrios
Se um nome de classe composto de mais de uma palavra, a primeira letra de cada
nova palavra deve ser maiscula. Letras maisculas em sequncia no so permitidas.
Ex: MyClass
Funes e mtodos
Nomes de funes devem conter somente caracteres alfanumricos, no sendo
underscores permitidos. Nmeros so permitidos mas desencorajados na maioria dos
casos.
Nomes de funes devem sempre comear com letra minscula e, quando consistir de
mais de uma palavra, a primeira letra de cada palavra deve ser maiscula. Esta
formatao comumente chamada de "camelCase".
A utilizao de verbos geralmente encorajada, devendo os nomes de funes ser to
verbais quanto prtico a fim de descrever de forma clara seu propsito e
comportamento.
Estes so exemplos de nomes aceitveis de funes:
?
1
2
3
4
5
filterInput()

getElementById()

widgetFactory()
Para programao orientada a objetos, acessores de variveis estticas ou de instncia
devem sempre ser prefixados com "get" ou "set". Ao implementar padres de design
(design patterns), como o singleton ou o factory, o nome do mtodo deve conter o
nome do padro onde prtico a fim de descrever claramente seu comportamento.
Para mtodos de objetos que so declarados com o modificador "private" ou "protected",
o primeiro caractere do nome do mtodo deve ser um underscore. Esta a nica
aplicao aceitvel de um underscore em um nome de mtodo. Mtodos declarados
como "public" nunca devem conter um underscore.
Funes em escopo global (tambm chamadas de "funes flutuantes") so permitidas
mas desencorajadas na maioria dos casos. Considere encapsular estas funes em
uma classe esttica.
Variveis
Nomes de variveis devem conter somente caracteres alfanumricos, no sendo
underscores permitidos. Nmeros so permitidos mas so desencorajados na maioria
dos casos.
Para variveis de instncia declaradas com o modificador "private" ou "protected", o
primeiro caractere do nome da varivel deve ser um underscore. Esta a nica
aplicao aceitvel de um underscore em nome de varivel. Variveis-membras
declaradas com "public" nunca devem comear com um underscore.
Assim como nomes de funes (veja seo 3.3), nomes de variveis devem sempre
comear com uma letra minscula e seguir a conveno "camelCase".
- Somente use abreviaes quando se tratar de domnio pblico, exemplo FGTS, fundo
de garantia por tempo de servio;



Sintaxe:
<TIPO><QUALIFICADOR><IDENTIFICADOR>
TIPO: identifica o tipo de dado (No o tipo da varivel). o termo mais geral no nome.
Exemplos:
code
date
name
value
QUALIFICADOR: especificam detalhes que qualificam o tipo de dado.
No so obrigatrios. Quando utilizados, devem ser codificados do mais geral para o
mais especifico.
Exemplos:
Proceeds
Birth
Salary
IDENTIFICADOR: identifica a entidade ou relacionamento que possui o dado como um
de seus atributos.
Exemplos:
Funcionario
Consumer
Supplier
Department

Exemplo:
acronymSector
birthDateConsumer
functionarySonName



Constantes
Constantes devem conter tanto caracteres alfanumricos quanto underscores. Nmeros
so permitidos.
Todas as letras usadas em um nome de constante devem ser maisculas, enquanto
todas as palavras devem ser separadas por underscores.
Por exemplo, EMBED_SUPPRESS_EMBED_EXCEPTION permitido
enquanto EMBED_SUPPRESSEMBEDEXCEPTION no.
Constantes devem ser definidas como membras de classe com o modificador "const".
Definir constantes em escopo global com a funo "define" permitido mas fortemente
desencorajado.