Autor: Pablo Rene Monroy Sánchez
Correo electrónico: correo arroba pablomonroy punto com punto mx
Sitio de Red: http://www.pablomonroy.com.mx/
Jabber ID: pablomonroy@jabber.org
Creative Commons
© 2006 Pablo Monroy. Usted es libre de copiar, distribuir y comunicar públicamente la obra y hacer obras derivadas bajo las condiciones siguientes: a) Debe reconocer y citar al autor original. b) No puede utilizar esta obra para fines comerciales. c) Si altera o transforma esta obra o genera una obra derivada, sólo puede distribuir la obra generada bajo una licencia idéntica a ésta. Al reutilizar o distribuir la obra, tiene que dejar bien claro los términos de la licencia de esta obra. Alguna de estas condiciones puede no aplicarse si se obtiene el permiso del titular de los derechos de autor. Los derechos derivados de usos legítimos u otras limitaciones no se ven afectados por lo anterior. Licencia completa en castellano. La información contenida en este documento y los derivados de éste se proporcionan tal cual son y los autores no asumirán responsabilidad alguna si el usuario o lector hace mal uso de éstos.
Las sentencias SQL dentro de php deberán estar en siempre en minúsculas y en líneas múltiples
Ejemplo:
$minusculas_con_guion_bajo
$minusculas_con_guion_bajo
minusculasMayuscula(
) $minusculas_con_guion_bajo()
Ejemplos:
MayusculasMinusculas
MAYUSCULAS_CON_GUION_BAJO
Cuando se incluyan otros archivos en nuestro código usando require_once y include_once ya que estas no son propiamente llamadas a funciones no es necesario usar los paréntesis.
Ejemplos:
Se recomienda que la longitud de las líneas en archivos sean de un máximo de 80 caracteres.
Se recomienda que ningún bloque del código -sin separación de líneas en blanco- sea más largo que una sola pantalla (aproximadamente ~30 líneas). La limitación de la longitud de los bloques del código hace más fácil la lectura del código.
Cuando en una sola línea se escriben varias sentencias, para efecto de una mejor lectura puede partirse en varias líneas para una mejor lectura.
Ejemplo:
Si tiene varias sentencias escritas una tras otra, puede hacer espacios para que alinear su código y sea más entendible.
También es recomendable dejar un espacio en blanco entre operadores para un mejor entendimiento de las sentencias. Una excepción es el "." que sirve como concatenador, además del ";" del final de cada línea.
Ejemplo:
Es recomendable la longitud del tabulador y de la indentación en su editor sea establecida en 4 espacios.
La llaves siempre debe de ser incluidas cuando usamos las sentencias if, for, while etc. No hay excepciones a esta regla.
Ejemplo de usos incorrectos/correctos usando llaves:
Debe tomarse el siguiente ejemplo para el uso de llaves
Esto incluye las instrucciones if, for, while, switch, etc.
Para la sentencia switch :
Para nombrar clases ver , para documentar la clase ver
Definir siempre si los métodos y propiedades son: public, protected, private
Ejemplo:
Todas las clases, métodos, funciones y características requieren docblocks. Docblocks es analizado por phpDocumenter que genera automáticamente la documentación.
Las reglas para Docblocks son las siguientes
Vea el manual del phpDocumenter para más información
Ejemplo: