Buenas prácticas en PHP: Código Estándar
Generalmente destinamos la mayoría de nuestros esfuerzos a que nuestro código funcione tal y como esperamos, pero no siempre prestamos suficiente atención a las formalidades, por ejemplo: comentarios, espacios, extensión de lineas, identación, etc
Mantener un estándar en el código que escribimos es muy recomendable, nos ayuda a mantener proyectos ordenados y de fácil lectura para el resto de las personas. Luego, es una buena práctica que sigas siempre los consejos de un buen estándar como, por ejemplo, el de PEAR.
El documento “PEAR2 Coding Standards” te entrega una serie de consejos para escribir código basado en buenas prácticas que tienen como objetivo mantener el orden y la facilidad de lectura. Sin embargo, revisar un archivo medianamente grande buscando cumplir con dicho documento puede ser una tarea extenuante. Es por esto que existe una herramienta que hace esto automática: PHP_CodeSniffer.
PHP_CodeSniffer es un paquete PEAR que chequea nuestros archivos PHP y nos dice que errores tenemos, indicando la linea y la recomendación de modificación.
Para instalar PHP_CodeSniffer necesitamos tener disponible en nuestro sistema a PEAR, si ya lo tenemos ejecutamos lo siguiente como root:
pear install PHP_CodeSniffer-1.2.0Una vez instalado para verificar un archivo PHP ejecutamos:
phpcs ruta_a_nuestro_archivo.php
Para generar un documento con los errores podemos hacer:
phpcs ruta_a_nuestro_archivo.php > errores_mi_archivoUn ejemplo del resultado a continuación:
——————————————————————————–
FOUND 16 ERROR(S) AND 1 WARNING(S) AFFECTING 9 LINE(S)
——————————————————————————–
15 | ERROR | Expected “foreach (…) {\n”; found “foreach(…){\n”
16 | ERROR | Line indented incorrectly; expected at least 4 spaces, found 1
16 | ERROR | Spaces must be used to indent lines; tabs are not allowed
28 | ERROR | No space found after comma in function call
28 | ERROR | No space found after comma in function call
28 | WARNING | Line exceeds 85 characters; contains 96 characters
——————————————————————————–
Aunque parezca raro, resulta muy entretenido verificar los errores que encuentra PHP_CodeSniffer y poder ir solucionando cada uno. El resultado es un script mucho más ordenado y entendible.
