Conocer y seguir los estándares de la industria y las mejores prácticas es muy importante en cualquier campo, y especialmente en la programación con su combinación compleja y, a veces, caótica de lenguajes de codificación, herramientas, enfoques y tecnologías. Es por eso que un programador profesional de Java debe estar bien familiarizado con las convenciones de codificación de Java, que es de lo que vamos a hablar hoy.
¿Qué son las convenciones de codificación?
Las convenciones de codificación son conjuntos de pautas para cada lenguaje de programación específico con recomendaciones sobre diferentes aspectos del desarrollo de software en este lenguaje, incluido el estilo de codificación, las mejores prácticas y los métodos. Las convenciones de codificación están destinadas a ser seguidas por los programadores de software que codifican en este lenguaje como guías de calidad para garantizar que su código sea legible y que sea posible el mantenimiento adecuado del software por parte de otras personas. Las convenciones de codificación normalmente cubren todos los componentes esenciales de la creación de software en este lenguaje de programación, incluida la organización de archivos, la sangría, los comentarios, las declaraciones, los espacios en blanco, las convenciones de nomenclatura, las prácticas de programación, los principios de programación, las reglas generales de programación, las mejores prácticas arquitectónicas y más. .
¿Cuál es el propósito de las convenciones de codificación?
Hay una serie de razones por las que las convenciones de codificación juegan un papel importante en el desarrollo de software.
Mantener el estilo de código unificado
Seguir una convención de codificación permite que el proyecto de software se escriba en un solo estilo unificado, lo que es beneficioso de varias maneras diferentes, como las siguientes.
Minimizar los costos de mantenimiento del software
Uno de los más importantes es facilitar el mantenimiento y el soporte del producto de software, ya que muy a menudo los autores originales del programa no son quienes lo soportan. Esto es importante ya que el 80% del costo de por vida de una pieza de software se destina al mantenimiento.
Mejorar la legibilidad del software
La mejora de la legibilidad del software es otro beneficio importante, que también tiene múltiples implicaciones, como simplificar la introducción de nuevos desarrolladores al proyecto y aumentar la eficiencia de la colaboración de los miembros del equipo de desarrollo.
Acelerando el trabajo
Finalmente, tener un código escrito y estructurado correctamente es necesario para que el proceso de desarrollo de software sea lo más rápido posible.
La Convención de Código de Oracle es reconocida como la más importante por varias razones obvias: La convención de Oracle es la oficial ya que Oracle es el propietario de Java, así como una de las más antiguas (la última revisión de este documento se realizó el 20 de abril de 1999). Algunas de las partes importantes de la Convención del Código Java de Oracle serían la recomendación de usar camel case al definir clases, métodos o variables, comenzar las clases con una letra mayúscula y usar sustantivos para nombrarlas, mientras usa verbos en forma imperativa y comienza de una letra minúscula para los métodos, y así sucesivamente.
Guía de estilo Java de Google
Las convenciones de codificación de Java de Google se consideran importantes debido al estado de Google como la empresa tecnológica y de aprendizaje de Internet con una enorme experiencia en el desarrollo de todo tipo de aplicaciones Java. Otra razón importante es el hecho de que la convención de código Java de Google se actualizó el 22 de mayo de 2018, lo que la hace más relevante que la convención de código de Oracle, especialmente cuando se trata de describir funciones relativamente nuevas de Java que solo se lanzaron como parte de Java 8. en 2014, como lambdas y arroyos. Así es como los autores de la Guía de estilo Java de Google describen el contenido de esta convención de codificación: “Este documento sirve como la definición completa de los estándares de codificación de Google para el código fuente en Java. Al igual que otras guías de estilo de programación, los temas tratados abarcan no solo cuestiones estéticas de formato, pero también otros tipos de convenciones o estándares de codificación. Sin embargo, este documento se enfoca principalmente en las reglas estrictas que seguimos universalmente, y evita dar consejos que no se pueden hacer cumplir claramente (ya sea por humanos o herramientas)”. “La Guía de estilo de Java de Google es una buena referencia en su mayor parte, pero es un poco permisiva en algunos temas. Por otro lado, como programador de Java, debe estar acostumbrado a 4 espacios para la sangría del código, entre otras cosas”, dijo David Rios, arquitecto de software y programador de Java con experiencia, en un LinkedIn. pero es un poco permisivo en algunos temas. Por otro lado, como programador de Java, debe estar acostumbrado a 4 espacios para la sangría del código, entre otras cosas”, dijo David Rios, arquitecto de software y programador de Java con experiencia, en un LinkedIn. pero es un poco permisivo en algunos temas. Por otro lado, como programador de Java, debe estar acostumbrado a 4 espacios para la sangría del código, entre otras cosas”, dijo David Rios, arquitecto de software y programador de Java con experiencia, en un LinkedIn.publicación con algunas adaptaciones propuestas a la Guía de estilo Java de Google propias.
Estándares de codificación Java más utilizados
Estos son algunos de los estándares de codificación de Java más utilizados que se pueden encontrar en las convenciones de codificación mencionadas anteriormente de Oracle y Google, así como en otros documentos de este tipo.
Siga la convención de nomenclatura adecuada;
Añadir comentarios;
Identificador significa un nombre simbólico que se refiere al nombre de clases, paquetes, métodos y variables en un programa Java;
El nombre de la variable debe estar relacionado con su propósito;
El nombre del método debe relacionarse con la funcionalidad del método;
El método no debe contener más de 50 líneas;
No debe haber código duplicado en la misma clase o en otra clase;
Declare variables globales solo si es necesario usar en los otros métodos;
Vuelva a verificar la creación de variables estáticas dentro de una clase;
Evite acceder a las variables directamente desde otras clases; en su lugar, utilice métodos getter y setter;
Toda la lógica comercial debe manejarse solo en la clase de servicio;
Todo el código relacionado con DB debe estar solo en las clases DAO;
Use getters y setters;
Declarar la variable de instancia como privada;
Mantenga el alcance de las variables mínimo;
Asigne nombres significativos a las variables;
Evite las fugas de memoria liberando las conexiones de la base de datos cuando finalice la consulta;
Trate de usar el bloque Finalmente con la mayor frecuencia posible;
Utilice el marco Executor para la programación multiproceso.
GO TO FULL VERSION