Guía de estilo Guía de estiloPor completar
No existe una guía de estilo oficial de cómo formatear un programa PHP, aunque el proyecto PEAR sí que dispone de una guía de estilo oficial, de la que se recogen aquí algunas recomendaciones:
La guía de estilo de PEAR no especifica otros aspectos, como el uso de comillas simples o dobles para delimitar cadenas, o el uso de paréntesis. Tan sólo recomienda que se utilice el mismo estilo en todos los ficheros.
Se debe utilizar un indentado de 4 espacios y no utilizar tabuladores.
Para configurar PsPad con estos criterios, en el menú "Opciones > Editor - opciones" tiene que estar desmarcada la opción "Tabuladores reales" y la opción "Tamaño del tabulador" debe ser 4. Así, cada vez que se pulsa la tecla Tabulador, PsPad escribe 4 espacios en blanco.
No se deben superar los 75-85 caracteres por línea.
En PsPad, la posición del margen derecho se indica por una línea punteada. La posición de la línea punteada se puede modiificar en la opción "Posición del margen derecho" del menú "Opciones > Editor - opciones" o haciendo clic en la regla situada encima del documento.
Las estructuras de control deben tener un espacio entre la palabra reservada y el paréntesis inicial, para distinguirlas de las funciones.
En los bloques de sentencias deben utilizarse siempre llaves, incluso cuando podrían omitirse (por ejemplo, cuando el bloque está formado por una única sentencia).
Ejemplos de esctructuras de control:
<?php |
<?php |
No debe haber espacios entre el nombre de la función, el paréntesis inicial y el primer argumento. Debe haber espacios tras las comas que separen argumentos. No debe haber espacios entre el último argumento, el paréntesis final y el punto y coma.
| <?php $var = foo($bar, $cel, $ona); ?> |
Las funciones deben declararse de acuerdo con el estilo "BSD/Allman":
<?php |
Los argumentos con valores predeterminados se colocan al final de la lista de argumentos.
Las funciones deben devolver algún valor.
Se debe utilizar // o /* ... */ para delimitar los comentarios. No se debe utilizar #.
Los framentos PHP deben delimitarse con <?php ... ?> y no con <? ... ?>.
<?php |
Por completar: mencionar JavaDoc y phpDocumentor.
Las URLs y direcciones de correo de ejemplo deben pertenecer a los dominios example.com, example.org o example.net, de acuerdo con la norma RFC 2606.
Por completar.
Los archivos deben guardarse en formato ASCII, utilizar la codificación ISO-8859-1 y utilizar el formato Unix (carácter LF como final de línea y al final de la última línea del archivo).
El código no debe generar errores o avisos cuando la directiva error_reporting tiene el valor E_STRICT.
Por completar.
PHP-Beatifier es un paquete PEAR que formatea automáticamente archivos PHP.
PHP_CodeSniffer es un paquete PEAR que detecta errores de formateo en archivos PHP.
phpDocumentor es un paquete PEAR que detecta errores de formateo en archivos PHP.
Autor: Bartolomé Sintes Marco