Guia de buenas prácticas en programación PHP

La gran mayoría hemos aprendido a progamar este lenguaje de forma autodidacta, cosa que provoca en la mayoría de ocasiones la falta de normalización en el código sobretodo si este ha de ser compartido con diferentes integrantes.

Esta guía, escrita por Fabien Potencier es un buen inicio.

Estructura

  • Nuca utilices etiquetas cortas (<?);
  • No finalices los ficheros de clases con el típico tag de cierre ?>;
  • La sangria se hace con grupos de cuatro espacios (la tabulación nunca está permitida);
  • Utiliza el carácter de salto de linea (0x0A) para poner fin a las líneas;
  • Añade un espacio simple después de cada coma delimitadora;
  • No añadas espacios después de la apertura de paréntesis o antes de cerrar unoAñade un epacio alrededor de los operadores (==, &&, …);
  • Añadir un espacio antes del paréntesis de apertura de una palabra clave de control  ( if , else , for , while , …);
  • Añadir una línea en blanco antes de regresar declaraciones;No agregue espacios finales al final de las líneas;
  • Utiliza llaves para indicar el control la estructura del cuerpo, independientemente del número de declaraciones que contiene;
  • Coloca llaves en su propia línea de clases, métodos, y la declaración de funciones;
  • Separa la sentencia condicional y la apertura de la llave con un solo espacio y sin ninguna línea en blanco;
  • Declara la visibilidad de forma expresa para la clase, métodos y propiedades (el uso de var está prohibido);
  • Utiliza minúsculas para las constantes nativas de PHP: falso , verdadero , y nula . Lo mismo ocurre con array () ;
  • Utiliza mayúsculas para constantes con las palabras separadas por subguiones;
  • Define una clase por fichero;
  • Declara las propiedades de clase antes que los métodos;
  • Declara los métodos públicos primero, después los protegidos y finalmente los privados;

Convenciones con los nombres:

  • Utiliza texto “camelCase”, no subguiones, para variables, funciones y nombres de métodos;
  • Utiliza subguiones para opciones, argumentos y nombres de parámetros;
  • Utiliza namespaces para todas las clases;
  • Utiliza Symfony como el primer nivel de namespace;
  • Pon de sufijo Interface en las interficies;
  • Utiliza carácteres alfanuméricos y subguiones para los nombres de fichero;

Documentación:

  • Añade los bloques PHPDoc en todas las clases, métodos y funciones;
  • Las anotaciones @package y @subpackages no son utilizados
Anuncios

2 comentarios en “Guia de buenas prácticas en programación PHP

  1. He visto tu blog y me han parecido interesantes un par de guias (sobretodo la de Jenkins).

    Solo queria comentar, que el estilo de codigo que describe Fabien es el que se utiliza en Symfony y que es el que se llama PSR-1 y PSR-2
    http://cs.sensiolabs.org/

    Si se utiliza algun IDE para programar (yo uso PHPStorm) normalmente tienen este tipo de validaciones, y sino se puede ejecutar un validador para comprobar codigo.

    Yo una epoca tuve uno cada vez que hacia un commit de Git.

  2. Hola Aitor,

    Muchas gracias por tu comentario y por ampliar la información del estándar. Queda claro que es importante estructurar bien nuestro código así como testearlo.

    ¡Un saludo!

Responder

Introduce tus datos o haz clic en un icono para iniciar sesión:

Logo de WordPress.com

Estás comentando usando tu cuenta de WordPress.com. Cerrar sesión / Cambiar )

Imagen de Twitter

Estás comentando usando tu cuenta de Twitter. Cerrar sesión / Cambiar )

Foto de Facebook

Estás comentando usando tu cuenta de Facebook. Cerrar sesión / Cambiar )

Google+ photo

Estás comentando usando tu cuenta de Google+. Cerrar sesión / Cambiar )

Conectando a %s