Convenio de codificación específico para PHP

En todos los ficheros sólo se utilizaran caracteres alfanuméricos, guiones bajos y el guión normal.Los espacios están estrictamente prohibidos.

Las variables deben comenzar con el carácter '$' seguido de caracteres alfanuméricos, incluido el guión bajo.

La alineación debe consistir en aplicar 4 espacios en blanco, no estando permitido el uso de tabulaciones.

La terminación de la línea sigue la convención del archivo UNIX, por lo que las líneas deben finalizar con un salto de línea única (LF).

El código PHP siempre debe estar delimitado por las etiquetas php, evitando el uso de atajos. Si los ficheros sólo contienen código PHP entonces podemos omitir la etiqueta de cierre.

La concatenación de cadenas debe realizarse utilizando el operador ".", añadiendo un espacio delante y detrás del operador.

Cuando una cadena es literal (no contiene sustituciones) debe marcarse la cadena entre comillas simples.

Cuando una cadena incluye diferentes apóstrofes debe ir encerrada entre comillas dobles.

Un array unidimensional comienza situando el índice a 0. Cuando el array se declara utilizando el constructor, se debe dejar un espacio tras cada delimitador siguiendo criterios de legibilidad. Si el array es inicializado mediante el constructor cada linea sucesiva debe alinearse con la superior.

Las sustituciones dentro de una cadena deben realizarse utilizando los símbolos $, o {$ y }.

Todos los ficheros que contienen código PHP terminan con la extensión ".php", con la excepción de la vista de los scripts.

Los siguientes elementos deben ser documentados siguiendo una estructura adecuada y utilizando etiquetas específicas:

• Sentencias define[_once].
• Sentencias include[_once].
• Funciones.
• Clases.
• Métodos y atributos.
• Variables globales.
• Archivo de código.

Se recomienda el uso de una plantilla para favorecer la legibilidad del código y cuando vayamos a documentar varios elementos similares. Una plantilla se define de la misma manera que un bloque normal, lo único que cambia es el encabezado de la primera línea /*#@+ en lugar de /* , la declaración se irá añadiendo a los elementos hasta encontrar un elemento de cierre delimitado con /*#@-/.

Se recomienda usar la herramienta Doxygen para generar la documentación de PHP ya que permite elegir entre una gran variedad de formatos para generar la documentación.