30 de agosto de 2017


Precisamos obedecer alguns padrões de escrita de acordo com a Code Conventions da Oracle (2016). Na nomeação das classes, métodos e atributos não devem ser incluídos números ou caracteres especiais como _, #, @, * $, etc. As classes devem ser nomeadas com substantivos e ter sua inicial maiúscula. O nome da classe deve possuir o mesmo nome de seu arquivo, caso contrário, haverá erro durante a execução do aplicativo. Se essa classe possuir um nome composto, por convenção, esse nome deverá ter todas as suas iniciais maiúsculas. Ex: NomeDaClasse, não é interessante utilizar hífen ou underline para separar os nomes de uma classe com nome composto.

Cada método/função deve ser nomeado com verbo e ter sua inicial minúscula. O nome dos métodos não deve ser iniciado ou composto por caracteres especiais. Caso o nome seja composto, a primeira inicial é minúscula e as demais são letras maiúsculas. Ex: nomeDoMetodo.

Um atributo pode ser nomeado com um adjetivo ou um substantivo e ter sua inicial minúscula. De igual forma, o nome do atributo não deve conter caracteres especiais e caso seja composto, deverá possuir uma inicial minúscula e todas as demais iniciais das palavras que o compõe em letra maiúscula. Ex: nomeDoAtributo. De toda forma, é interessante escrever nome do atributo da forma mais simples possível, então, em vez de nomeDoAtributo, seria interessante nomeá-lo apenas como nome.

O nome de uma constante deve ser escrito com todas as letras maiúsculas. Caso a constante possua um nome composto, ele deve ser separado pelo caractere underline. Ex: NOME_DA_CONSTANTE. Essa é a única circunstância na qual o caractere underline deve ser usado na formação de nomes.

Todas essas regras de nomenclatura são utilizadas para deixar o código da forma mais organizada possível. Não devemos declarar variáveis locais com o mesmo nome de variáveis globais. É interessante utilizar sempre identificadores ainda não utilizados para funções, variáveis, métodos e classes. Dessa forma, a manutenção é facilitada já que poderão ser evitadas situações como uma variável comum ser confundida com uma constante ou que uma variável local seja confundida com uma variável global.

Referência:

ORACLE. Code Conventions for the Java Programming Language: Contents, 2016. Disponível em: <http://www.oracle.com/technetwork/java/codeconvtoc-136057.html>. Acesso em: 23 jan.2016.

Comentários:

Perfil

Formada em Sistemas de Informação e pós-graduada em Engenharia de Software.

Facebook

Views