Introdução à Convenção de Nomenclatura em Java
Neste artigo, abordaremos algumas convenções de nomenclatura que devem ser seguidas especialmente em Java para fins de manutenção e legibilidade do código, que ajudam um programador a entender e modificar o código escrito por outro programador. Podemos considerá-lo como uma diretriz que se pode seguir ao atribuir nomes às classes, variáveis ou métodos ou interfaces, etc. e torná-lo uma boa prática ao escrever códigos. As convenções de nomenclatura que discutiremos neste artigo são sugeridas e praticadas por muitos programadores Java e também suportadas pela Netscape e Sun Microsystems.
Sintaxe nas convenções de nomenclatura Java
Na linguagem de programação Java, o estilo de escrita em maiúsculas e minúsculas é usado para escrever nomes de métodos / funções, variáveis e estilo em maiúsculas e minúsculas para classes e interfaces. Vamos entender e entender as regras que se deve seguir ao nomear um elemento / entidade na linguagem de programação Java:
- Ao atribuir nomes às classes, devemos ter em mente que os nomes das classes devem ser um substantivo e começar com uma letra maiúscula.
Sintaxe: public class Employee ( //code snippet )
- No caso de interfaces, deve ser um adjetivo ab (que descreve o substantivo (uma classe que o implementa)) e começar com uma letra maiúscula. Em alguns casos, um nome de interface também pode ser um nome, quando representa uma família de classes, por exemplo: Mapa, Lista, etc.
Sintaxe: interface Printable ( //code snippet )
- Um nome de método deve começar com um verbo (definindo uma ação que o método implementará) e começar com uma letra minúscula.
Sintaxe: void printDetails() ( //code snippet )
- Considerando que, para variáveis, elas devem ser significativas, o que significa que tipo de informação está armazenando, seja um nome, endereço ou número de telefone etc. Ao escrever nomes de variáveis, precisamos garantir que não comece com caracteres especiais, como um dólar ($) ou um caractere de sublinhado (_), e seu nome não deverá ter espaços em branco e começará com uma letra minúscula.
Sintaxe: int eid, sal;string firstName, lastName;
- Os nomes das variáveis constantes devem estar em maiúsculas (todos em MAIÚSCULAS) e, separados por um sinal de sublinhado (_), seu nome consiste em mais de uma palavra.
Sintaxe: static final int MIN_SAL = 20000;
- Sabemos que o Java usa todas as letras minúsculas para atribuir nomes de pacotes e devemos seguir a mesma convenção de nomenclatura ao nomear nossos pacotes também.
Sintaxe: package src.employeedetails;
- As enumerações no seu código java devem ser maiúsculas, ou seja, todas as letras maiúsculas.
Sintaxe: enum JobPost ( MANAGER, ANALYST, HR, ADMIN, ENGINEER )
- As anotações em java podem ser um substantivo, verbo ou adjetivo e devem seguir o estilo de maiúsculas e minúsculas para nomear as anotações.
Sintaxe: public @interface Documented ()
Exemplos em convenções de nomenclatura Java
Agora, vamos escrever um código completo usando os trechos de código acima que o tornam mais significativo e nos ajuda a entender por que as convenções de nomenclatura a seguir são importantes ao escrever o código do aplicativo em qualquer linguagem de programação:
Exemplo 1
Código:
package src.employeedetails;
interface Printable (
void printDetails(); )
public class Employee implements Printable (
int eid;
double sal;
String firstName, lastName;
// Default Constructor
Employee() (
eid=0; sal=0.0;
firstName = "Anonymous"; lastName = "Anonymous";
)
// Parameterized Constructor
Employee(int eid, double sal, String firstName, String lastName) (
this.eid = eid; this.sal = sal;
this.firstName = firstName; this.lastName = lastName;
)
public void printDetails() (
System.out.println("Employee ID:" + eid + "\n" +
"Employee First Name:" + firstName + "\n" +
"Employee Last Name:" + lastName + "\n" +
"Employee Salary:" + sal + "\n" );
)
public static void main(String args()) (
Employee emp = new Employee(1, 22368.50, "Alan", "Hope");
emp.printDetails();
)
)
Resultado:
Exemplo 2
Código:
package src.customerdetails;
interface Printable ( void printDetails(); )
public class Customer implements Printable (
int custid;
long mobNo;
String fullName, emailAddr;
// Default Constructor
Customer() (
custid=0; mobNo=0;
fullName = "Anonymous"; emailAddr = " ";
)
// Parameterized Constructor
Customer(int custid, long mobNo, String fullName, String emailAddr) (
this.custid = custid; this.mobNo = mobNo;
this.fullName = fullName; this.emailAddr = emailAddr;
)
public void printDetails() (
System.out.println("Customer ID:" + custid + "\n" +
"Customer Full Name:" + fullName + "\n" +
"Customer Email Address:" + emailAddr + "\n" +
"Customer Mobile Number:" + mobNo + "\n" );
)
public static void main(String args()) (
Customer cust = new Customer (1, 987451036, "Alan Hope", " ");
cust.printDetails();
)
)
Saída 1:
Saída 2:
Vantagens das convenções de nomenclatura Java
Abaixo estão algumas vantagens na convenção de nomenclatura java:
- Redução de confusão na escrita ou código incorreto.
- Melhoria na legibilidade do código.
- Menos tempo gasto para descobrir o que o código faz.
- Melhoria na manutenção do código.
- Produza um código consistente em todo o aplicativo.
Conclusão
Da próxima vez que escrever um código Java, verifique se as classes, interfaces, pacotes, métodos e campos que você define e implementa têm nomes que seguem as convenções de nomenclatura Java. Lembre-se de que as convenções de nomenclatura a seguir em qualquer linguagem de programação é o primeiro passo para escrever código limpo e consistente e é provavelmente a primeira prática recomendada a ser seguida por todos os programadores.
Artigos recomendados
Este é um guia para convenções de nomenclatura Java. Aqui discutimos as classes, interfaces, pacotes, métodos e campos que definem e implementam as convenções de nomenclatura Java. Você também pode consultar nossos outros artigos relacionados para saber mais -
- Objeto em PHP
- Quadrados em Java
- Recursão em Java
- Fatorial em Java
- Variáveis em JavaScript
- Matrizes na programação Java
- Lista de Pacotes R
- Trabalho e os 3 principais métodos enum em C #
- Guia completo de fatorial em C #