Al iniciar el aprendizaje de un nuevo lenguaje de programación, es importante conocer sus mejores prácticas, ya que un buen programa no solamente es un algoritmo bien ejecutado, también la documentación y la forma en que se escribe el código son importantes.
Si documentamos bien, podremos dejar a los programadores que revisen nuestro código un buen camino para que entiendan que hicimos y las razones, de esta manera la continuidad de los proyectos es mejor; también un código legible nos ayuda a depurar errores y hace que podamos perder menos tiempo en factores diferentes que lograr nuestros objetivos.
Convención de Nombres
La convención de nombres es sumamente importante, con esto podemos identificar a simple vista variables de clases y métodos.
El primer aspecto importante es el estilo de escritura de los nombres, cuando tenemos nombres de variables debemos utilizar minúsculas y cuando tenemos constantes deben ir en mayúsculas, veamos:
Así cuando veamos PI sabremos que es una constante, en cambio si vemos divisor sabemos que es una variable y si la necesitamos manipular lo podremos hacer sabiendo que no afectaremos el programa.
Si tenemos nombres de varias palabras debemos utilizar el método camel case es decir hacer mayúscula la primera letra de las siguientes palabras del nombre.
Veamos los siguientes ejemplos:
En la imagen podemos observar como definimos una clase con varias palabras, en el caso de las clases hasta la primera palabra debe iniciar con mayúsculas.
Espacio e Identación
Cuando escribimos código anidado, por ejemplo clases y sus métodos, estos deben ir identados, es decir, deben llevar una separación con tabulador para denotar su anidamiento, con ello facilitamos la identificación de que partes pertenecen a cuales.
También debemos cuidar el espacio entre los diferentes elementos que conforman las declaraciones, ya que un mal uso puede generar un problema de legibilidad.
Veamos un ejemplo de cada cosa, por ejemplo el espacio entre elementos, en la imagen vemos la forma correcta en la parte inferior, donde cada elemento está separado por un espacio, sin embargo en la parte superior en la forma incorrecta vemos que no hay uniformidad en los espacios.
En el próximo gráfico vemos como se hace un bloque con una buena identación, podemos notar como cada elemento está anidado y separado por un salto de línea.
Documentación
Como mencionamos al inicio la documentación nos permite indicar dentro del código nuestros comentarios, para ello haremos uso de las herramientas de escribir comentarios en Java; por ejemplo si queremos documentar dentro del código cada paso que estamos llevando a cabo podemos utilizar // para generar una línea que será omitida por el compilador pero que puede ser leída en el archivo fuente.
Si al inicio de la clase hacemos un bloque de comentarios utilizando:
Lo que escribamos dentro de ese bloque podrá ser exportado y utilizado para generar documentos HTML con las herramientas de documentación de Java. Entonces debemos utilizar cada caso como corresponda.
Finalizando el tutorial tenemos una noción más amplia de las mejores prácticas al realizar programas en Java para de esta forma colaborar con el desarrollo a nivel funcional sino ir un poco más allá de nuestras responsabilidades como buen desarrollador.
Si documentamos bien, podremos dejar a los programadores que revisen nuestro código un buen camino para que entiendan que hicimos y las razones, de esta manera la continuidad de los proyectos es mejor; también un código legible nos ayuda a depurar errores y hace que podamos perder menos tiempo en factores diferentes que lograr nuestros objetivos.
Convención de Nombres
La convención de nombres es sumamente importante, con esto podemos identificar a simple vista variables de clases y métodos.
El primer aspecto importante es el estilo de escritura de los nombres, cuando tenemos nombres de variables debemos utilizar minúsculas y cuando tenemos constantes deben ir en mayúsculas, veamos:
int [b]divisor[/b] = 5; final double [b]PI[/b] = 3.14;
Así cuando veamos PI sabremos que es una constante, en cambio si vemos divisor sabemos que es una variable y si la necesitamos manipular lo podremos hacer sabiendo que no afectaremos el programa.
Si tenemos nombres de varias palabras debemos utilizar el método camel case es decir hacer mayúscula la primera letra de las siguientes palabras del nombre.
Veamos los siguientes ejemplos:
En la imagen podemos observar como definimos una clase con varias palabras, en el caso de las clases hasta la primera palabra debe iniciar con mayúsculas.
Espacio e Identación
Cuando escribimos código anidado, por ejemplo clases y sus métodos, estos deben ir identados, es decir, deben llevar una separación con tabulador para denotar su anidamiento, con ello facilitamos la identificación de que partes pertenecen a cuales.
También debemos cuidar el espacio entre los diferentes elementos que conforman las declaraciones, ya que un mal uso puede generar un problema de legibilidad.
Veamos un ejemplo de cada cosa, por ejemplo el espacio entre elementos, en la imagen vemos la forma correcta en la parte inferior, donde cada elemento está separado por un espacio, sin embargo en la parte superior en la forma incorrecta vemos que no hay uniformidad en los espacios.
En el próximo gráfico vemos como se hace un bloque con una buena identación, podemos notar como cada elemento está anidado y separado por un salto de línea.
Documentación
Como mencionamos al inicio la documentación nos permite indicar dentro del código nuestros comentarios, para ello haremos uso de las herramientas de escribir comentarios en Java; por ejemplo si queremos documentar dentro del código cada paso que estamos llevando a cabo podemos utilizar // para generar una línea que será omitida por el compilador pero que puede ser leída en el archivo fuente.
Si al inicio de la clase hacemos un bloque de comentarios utilizando:
/** /* /* **/
Lo que escribamos dentro de ese bloque podrá ser exportado y utilizado para generar documentos HTML con las herramientas de documentación de Java. Entonces debemos utilizar cada caso como corresponda.
Finalizando el tutorial tenemos una noción más amplia de las mejores prácticas al realizar programas en Java para de esta forma colaborar con el desarrollo a nivel funcional sino ir un poco más allá de nuestras responsabilidades como buen desarrollador.
