Aunque el título se refiera al programador Java, estas reglas son aplicables a cualquier tipo de programador. A excepción de la regla número 6, que es específica al lenguaje de programación Java.

1. Comenta el código.
Cuando estamos escribiendo código nuevo, es fácil entender lo que se está haciendo, pero si no tocamos ese código por un periodo de tiempo y tenemos que volver al mismo, ya no es tan obvio. Comentar el código te ayudará a entender más rápidamente la lógica del programa.
2. No compliques las cosas.
Muchas veces queremos solucionar algún problema de la forma más enredada porque está guay. Busca la forma más simple de resolver las cosas. Esto te ayudará a entender el código mejor y a mantenerlo de una manera más eficiente y es menos propenso a errores.
3. Menos es más, no es siempre bueno.
Muchos lenguajes de programación te permiten concatenar funciones y muchas veces queremos hacer varias cosas a la vez en una línea. Esto dificulta la lectura y la lógca del código.
4. Evita el hard coding.
Usa las constantes, de este modo si necesitamos cambiar este valor, sólo tenemos que hacerlo en la constante y no en el resto del código. Si es valor es algo que va a ir cambiando a lo largo de la vida del programa, sería mejor usar ficheros externos de configuración (XML, propiedades, base de datos, etc), de esta forma no tenemos que modificar el código, recompilar y redistribuir la nueva versión.
5. No reinventes .
Aprovéchate de los marcos de trabajo (frameworks) existentes y de los patrones de diseño. Están ampliamente probados.
6. Cuidado con los prints y la concatenación de Strings.
Normalmente tendemos a escribir prints por todo el programa, con la intención de depurar nuestra aplicación. Esto puede afectar seriamente al rendimiento de la aplicación. Usa algún tipo de mecanismo para que esos prints solo se ejecuten cuando estemos en la fase de desarrollo. La concatenación de String puede ser otra de las operaciones que afectan al rendimiento del programa. Si vas a hacer muchas operaciones de concatenación, en Java la clase String es inmutable, por lo tanto cada vez que haces una concatenación estás desreferenciando los Strings que estas concatenando y creando un nuevo String. En Java tienes disponibles 2 clases que aumentan drásticamente el rendimiento para este tipo de operaciones. StringBuffer y StringBuilder. StringBuilder es incluso más rápido que StringBuffer, ya que este no es thread-safe. Por lo tanto si el código de desde el que estas haciendo las concatenaciones no es multihilo usa StringBuilder, si no, usa StringBuffer.
7. Pon atención al interfaz de usuario.
El aspecto del interfaz de usuario, la forma de navegar por el mismo y la comodidad a la hora de usar el mismo, van a depender mucho de la aceptación y el éxito de tu aplicación. Sigue el mismo estilo en toda la aplicación, escoge cuidadosamente el título de las ventanas, etiquetas de texto, etc. Sigue el mismo diseño que otros sistemas ampliamente aceptados. Pon tu interfaz a pruebas con tu mujer, marido, novi@, amig@, etc. Para ver como se mueve por la aplicación, etc.
8. Documentación.
Es lo que personalmente odio más. Escribir documentación es muy pesado y en el momento en el que estamos trabajando en un proyecto todo tiene sentido y fácil de seguir. Pero de nuevo, cuando tenemos que volver al proyecto después de un tiempo ya no nos parecerá tan obvio como pensabamos. Además si el proyecto no era lo suficiente grande como para requerir a más de una persona para trabajar en el mismo, recuerda que el proyecto puede crecer y requerir a uno o más programadores incorporarse al proyecto. O simplemente el proyecto pasa a manos de otra persona. Es una de las tareas más pesadas, pero de las que más que se agradecen a lo largo del tiempo.
9. Unidades de testeo.
Es una muy buena y reomendada práctica que debemos hacer incluso antes de escribir nuestros paquetes, librerías, etc. Y son las unidades de testeo. Esto nos va a ayudar de una forma muy rápida si nuestras funciones funcionan como deben. Nos va ahorrar mucho tiempo en el futuro (cada vez que tengamos que modificar nuestras funciones) y es otra de las tácticas que nos ayudará a reducir el número de errores en nuestro programa.
10. Calidad, no cantidad.
Es mejor entregar un programa con las funciones básicas bien desarrolladas, a entregar un programa lleno de funciones y que cada dos por tres el mismo se cuelgue o no haga lo que se supone que tiene que hacer.

Aunque el título se refiera al programador Java, estas reglas son aplicables a cualquier tipo de programador. A excepción de la regla número 6, que es específica al lenguaje de programación Java.

Anuncios