Introducción
El presente documento es un estandar de programación que puede ser utilizado para aplicacciones hechas en PHP. Algunas partes del documento pueden ser compatibles con otros lenguajes de programación.
El objetivo: dar las herramientas que permitan una mejor organizacion en el código, facilitar el entendimiento del mismo por los programadores y optimizar el desarrollo de aplicaciones WEB en la plataforma PHP.
Siguiendo los estandares de este documento podrás:
- Tener Legibilidad en el código
- Conocer el historial de cambios en los archivos programados
- La descipcion de cada archivo
- Quien ha estado involucrado en el desarrollo del archivo
- Encontrar diferencias de lenguages como SQL, HTML,PHP,JavaScript
- Identificar variables pre definidas, variables locales
- Hacer buena practica de programacion
- Reducir tiempo de ejecucion en algunos procesos.
Desarrollo
Encabezado de archivos
Todos los archivos .php deben contener un “flowerbox” o bien caja de modificaciones, la cual contiene nombre del programa, descripción, historial de modificaciones, relacion de modificaciones con proyectos de desarrollo.
Ej.
/*************************************************************
** Programa: config.php
** Descripcion: Archivo de configuracion del sistema HelpDesk
** proyecto fecha por descripcion
** ---------- --------- ----------- ----------------
** app00001 31/01/09 mmendoza Creado.
**************************************************************/
Extenciones de archivos
Nota: no utilizar extenciones en MAYUSCULAS
- Archivos php .php
- Clases php .class.php
- JavaScript .js
- Estilos css .css
Comentarios en código
- Siempre Commentar donde finaliza cada funcion
- Commentar donde se considere que el proceso es dificil de identificar el inicio y el final
/*funcion de validacion de correo*/
function validaMail($pMail) {
if(ereg("^[_a-zA-Z0-9-]+(\.[_a-zA-Z0-9-]+)*@+([_a-zA-Z0-9-]+\.)*[a-zA-Z0-9-]{2,200}\.[a-zA-Z]{2,6}$", $pMail ) ){
return true;
}else{
return false;
} /*end else*/
} /*end validaMail()*/
Caracteres especiales
- No usar acentos en el código, incluso en el codigo comentado
Ej. Mal /*configuración de la clase*/
Bien /*configuracion de la clase*/
- Usar caracteres entre [A-Z , a-z, 0-9]
- Para impresion de HTML con caracteres especiales utilizar el codigo especificado en html para dicho caracter.
Ej. Bien <? echo ‘Guardar Sesión’;?>
Mal <? echo ‘Guardar Sesión’;?>
Trata de imprimir el menos codiho Html posible desde PHP. Eso permite que PHP solo ejecute procesos de codigo en los que se requiera php y el Html ya esta listo para ser reconocido por el cliente, por lo tanto optimizas el procesamiento de ejecucion de php.
Ej.
No Recomendado<?php if($ok==true){ echo ‘<strong>Se ejecuto la consulta</strong>’;’ } ?>
Recomendado <?php if($ok==true){ ?> <strong>Se ejecuto la consulta</strong><? } ?>