Introducción a la Convención de nomenclatura en Java
En este artículo revisaremos algunas convenciones de nomenclatura que deben seguirse especialmente en Java para fines de mantenimiento y legibilidad del código, que ayudan a un programador a comprender y modificar el código escrito por otro programador. Podemos considerarlo como una guía que se puede seguir al asignar nombres a las clases, variables o métodos o interfaces, etc. y convertirlo en una buena práctica al escribir códigos. Las convenciones de nomenclatura que discutiremos en este artículo son sugeridas y practicadas por muchos programadores de Java y también respaldadas por Netscape y Sun Microsystems.
Sintaxis en las convenciones de nomenclatura de Java
En el lenguaje de programación Java, el estilo de escritura en mayúsculas y minúsculas se usa para escribir nombres de métodos / funciones, variables y estilo de mayúsculas y minúsculas para clases e interfaces. Veamos y comprendamos las reglas que se deben seguir al nombrar un elemento / entidad en Java Programming Language:
- Al asignar nombres a las clases, debemos tener en cuenta que los nombres de las clases deben ser un sustantivo y comenzar con una letra mayúscula.
Sintaxis: public class Employee ( //code snippet )
- En el caso de las interfaces, debe ser un adjetivo ab (que describe el sustantivo (una clase que lo implementa)) y comenzar con una letra mayúscula. En algunos casos, un nombre de interfaz también puede ser un sustantivo, cuando representan una familia de clases, por ejemplo: Mapa, Lista, etc.
Sintaxis: interface Printable ( //code snippet )
- El nombre de un método debe comenzar con un verbo (que define una acción que el método va a implementar) y comenzar con una letra minúscula.
Sintaxis: void printDetails() ( //code snippet )
- Mientras que para las variables, deben ser significativas, lo que significa qué tipo de información está almacenando, ya sea un nombre, una dirección o un número de teléfono, etc. Al escribir los nombres de las variables, debemos asegurarnos de que no comience con caracteres especiales como un dólar ($) o un carácter de signo de subrayado (_) y su nombre no debe tener espacios en blanco y comience con una letra minúscula.
Sintaxis: int eid, sal;string firstName, lastName;
- Los nombres de las variables constantes deben estar en mayúsculas (todo en MAYÚSCULAS) y separados con un signo de subrayado (_), su nombre consta de más de una palabra.
Sintaxis: static final int MIN_SAL = 20000;
- Sabemos que Java usa todas las letras minúsculas para asignar nombres de paquetes y debemos seguir la misma convención de nomenclatura al nombrar nuestros paquetes también.
Sintaxis: package src.employeedetails;
- Las enumeraciones en su código de Java deben estar en mayúscula, es decir, todas las letras mayúsculas.
Sintaxis: enum JobPost ( MANAGER, ANALYST, HR, ADMIN, ENGINEER )
- Las anotaciones en java pueden ser un sustantivo, un verbo o un adjetivo y deben seguir el estilo de mayúsculas y minúsculas para nombrar las anotaciones.
Sintaxis: public @interface Documented ()
Ejemplos en convenciones de nomenclatura de Java
Ahora, escribamos un código completo utilizando los fragmentos de código anteriores que lo hace más significativo y nos ayuda a comprender por qué es importante seguir las convenciones de nomenclatura al escribir el código de la aplicación en cualquier lenguaje de programación:
Ejemplo 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();
)
)
Salida:
Ejemplo # 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();
)
)
Salida 1:
Salida 2:
Ventajas de las convenciones de nomenclatura de Java
A continuación se presentan algunas ventajas en la convención de nomenclatura de Java:
- Reducción en la escritura de confusión o código erróneo.
- Mejora en la legibilidad del código.
- Menos tiempo dedicado a descubrir qué hace el código.
- Mejora en la mantenibilidad del código.
- Produzca un código consistente en toda la aplicación.
Conclusión
La próxima vez que escriba un código Java, asegúrese de que las clases, interfaces, paquetes, métodos y campos que defina e implemente tengan nombres que sigan las convenciones de nomenclatura Java. Recuerde que las siguientes convenciones de nomenclatura en cualquier lenguaje de programación es el primer paso para escribir código limpio y consistente y es probablemente la primera mejor práctica que todos los programadores deben seguir.
Artículos recomendados
Esta es una guía de las convenciones de nomenclatura de Java. Aquí discutimos las clases, interfaces, paquetes, métodos y campos que definen e implementan las convenciones de nomenclatura de Java. También puede consultar nuestros otros artículos relacionados para obtener más información:
- Objeto en PHP
- Cuadrados en Java
- Recursion en Java
- Factorial en Java
- Variables en JavaScript
- Matrices en programación Java
- Lista de paquetes R
- Métodos de trabajo y Top 3 Enum en C #
- Guía completa de Factorial en C #