Buenas Practicas de Programación
| Convenciones de nombres | |
|---|---|
| Clases | Los nombres de las clases deben ser CamelCase, con la inicial en mayúscula. Es una buena practica usar el “estilo PEAR” para manejar la jerarquía de nuestras clases, esto también ayuda a ubicar los archivos de forma jerárquica y ordenada. |
| Archivos | Solo caracteres alfanuméricos, comenzando en mayúscula, los espacios no están permitidos. |
| Variables, propiedades, funciones y métodos | Estos nombres deberán ser camelCase, con la inicial en minúscula. |
| Los métodos llamados “Accessors” | Utilizaran los prefijos set y get, usando la regla anterior, por ejemplo setVar1 y getVar1. |
| Constantes | Las constantes de código (por ejemplo los generados con #define de C/C++ o define() de PHP deberán estar en MAYÚSCULAS. |
| Propiedades y métodos privados | Los elementos privados usaran un “guion bajo” al inicio, por ejemplo _nombreVar. |
| Convenciones de llaves |
|---|
| Las funciones y clases deberán tener su llave inicial en la siguiente linea a la declaración y en el mismo nivel de indentación. Las estructuras de control siguen la regla anterior, algunas personas recomiendan poner la llave inicial en la misma linea de la estructura, es cuestión de gustos… Se recomienda que todas las estructuras de control usen llaves, nada de sentencias inline, yo no sigo mucho esta regla, aunque puede ser recomendable… |
| Indentación… |
|---|
| Se recomienda usar solamente espacios no tabs, 4 espacios por nivel de indentación, la mayoría de los editores pueden ser configurados para que conviertan nuestros tabs en espacios ayudándonos a cumplir este requisito. |
| Valores boleanos y null |
|---|
| En los lenguajes donde sea indiferente el usar “null”, “false” y “true” con mayúsculas o minúsculas, siempre serán usados en minúsculas. |
| Métodos y funciones |
|---|
| Cuando el parámetro de un método sea opcional, y no se tenga preferencia sobre algún valor default se debe usar “null” en lugar de “false”. Los parámetros deberán estar separados por un espacio en blanco después de cada coma. |
| Programación orientada a objetos |
|---|
| Una sola clase por archivo, y nada de código fuera del contexto de la clase. Siempre que se declaren métodos o atributos de una clase, se debe especificar explícitamente el nivel de visibilidad que tienen, generalmente se maneja public, private y protected. Usen namespaces para agrupar sus clases y evitar colisión de nombres. |
| Comentarios |
|---|
| Trata de comentar tu código, de preferencia usa un formato estándar como el de JavaDoc o PHPDoc, existen muchas aplicaciones que pueden hacer uso del mismo. Comenta las partes de tu código que sean relevantes, evitar poner antes de tu ciclo: “Recorro el arreglo…”, los comentarios son de gran ayuda pero podrían llegar a estorbar si no se usan bien, algunos excelentes ejemplos de lo que no se debe hacer los encuentran aquí. |
| Bases de datos |
|---|
| Utilizar caracteres alfanuméricos Limitar los nombres a menos de 64 caracteres (es una restricción de MySQL). Utilizar el guión bajo (_) para separar palabras. Utilizar palabras en minúsculas, algunos motores te lo convierten automáticamente. Los nombres de las tablas deberían ir en plural y los nombres de las columnas en singular. En una tabla, colocar primero la clave primaria seguida de las claves foráneas. |
Fuente original: Hector Benitez
