Codificación Estandar - Primera Parte

 Es muy importante recordar que una rutina será leída más veces de las que será re escrita, y que además, posiblemente (es más que probable) sea leída por diferentes personas, por lo que hacer un código entendible es una tarea que no debe ser pasada por alto.

“En el apuro por cumplir un plazo de desarrollo de aplicaciones, es fácil descuidar el estilo y la legibilidad.”

Nigel Cheshire

Alcance

Básicamente los temas a cubrir serían:

• Formato de los archivos PHP.
• Convenciones de nombres (segunda parte).
• Estilo de Codificación (tercera parte).
• Documentación inline (cuarta parte).

Metas

Tener estándares de codificación es importante dentro del ciclo de vida de un proyecto, pero esto se hace más evidente cuando varios desarrolladores participan en el esfuerzo. Adoptar estándares asegura que el código será comprensible, que tendrá pocos errores y que su mantenimiento consumirá menos horas hombre (mujer).

Formato de los archivos PHP

General

Si un archivo incluye solamente código PHP, la marca de finalización de PHP (”?>”) no está permitida. No es requerida por PHP. No incluirla previene la inclusión de algún espacio en la salida accidentalmente.

Espacios

Usar espacios en blanco para mejorar la legibilidad del código.

• Usar espacion en blanco a ambos lados del operador de símbolos, después de comas y después de las declaraciones.
• Usar líneas en blanco para separar trozos de código.
• Usar líneas en blanco antes de cada método dentro de una clase.

Saltos de línea

• Añadir un salto de línea después del cierre de los paréntesis de los parámetros.
• Añadir un salto de línea después un punto y coma, cuando termina la sentencia.

Indentación

Utilizar siempre 4 espacios y no tabulaciones para indentar (la mayoría de los IDEs modernos permiten configurar que al presionar la tecla TAB se inserten un número arbitrario de espacios).

Longitud de las líneas de código

El objetivo al escribir código PHP estándar es tener líneas de código que no superen los 80 caracteres. Este es un límite práctico que permite abarcar la totalidad de la línea con un solo vistazo. Sin embargo, líneas de mayor longitud son aceptables si la situación lo requiere (el límite máximo para cualquier línea PHP es de 120 caracteres).

Para mantener la longitud de las líneas de código dentro de la longitud sugerida podemos seguir los siguientes principios:

• Salto de línea después de una coma.
• Salto de línea después de un operador.
• Alinear la nueva línea con el principio de la expresión en el mismo nivel en la línea anterior.

Bueno, eso es todo por ahora. En la próxima entrega hablaremos sobre convenciones de nombres: cuales seguir y para que sirven.

Saludos.

:D