compartimos
la actualidad contigo

13 ene 2009

Normas para escribir en php

Usaremos estas normas para que nuestro código sea más legible Tabs o Espacios En el contenido dentro de corchetes, siempre se identará este contenido con tabs. Cabecera del archivo Es recomendable que todos los archivos .php inicien con una cabecera específica que indique información de la versión, autor de los últimos cambios, etc. //----------------------------------------------------------------------------------- // Funciones Genéricas de manejo PHP // Escrito por fulanitin el día asdfasdfasd

Usaremos estas normas para que nuestro código sea más legible

Tabs o Espacios
En el contenido dentro de corchetes, siempre se identará este contenido con tabs.

Cabecera del archivo

Es recomendable que todos los archivos .php inicien con una cabecera específica que indique información de la versión, autor de los últimos cambios, etc.

//----------------------------------------------------------------------------------- // Funciones Genéricas de manejo PHP // Escrito por fulanitin el día asdfasdfasd

Comentarios en las funciones Todas las funciones deben tener un comentario, antes de su declaración, explicando que hacen. No debería ser preciso analizar el código de una función para conocer su utilidad. Tanto el nombre como el comentario que acompañe a la función deben bastar para ello, en ese comentario hay que documentar los parámetros si no son lo suficientemente claros. Dentro de las funciones los procesos deben de estar comentados (es mejor pasarse que quedarse corto) de tal manera que otro programador pueda entender de forma rápida lo que hace el código sin tener que analizarlo. Clases Las clases serán colocadas en un archivo .php aparte, donde sólo se colocará el código de la clase. El nombre del archivo será el mismo del de la clase. En lo posible, procurar que los nombres de clase tengan una sola palabra. Las clases siguen las mismas reglas de las funciones, por tanto, debe colocarse un comentario antes de la declaración de la clase explicando su utilidad. Gochadas Si por prisa o necesidad hacemos una gochada en el código y somos conscientes de ella debe de ser comentada para que otra persona los pueda buscar rápidamente y poder reemplazarlos por soluciones mejores. En el comentario hay que introducir la cadena OJO así como el motivo por el que se ha usado esa solución y posibles mejoras. Ubicación de archivos En proyectos web o aplicaciones, se clasificarán los archivos en carpetas / Carpeta raiz: Aquí irán los archivos .php a los que accede el usuario directamente, interfaz, etc. js: contiene el javascript Connections: Las conexiones con la base de datos intranet: Contenido de intranet. templates: para el sistema de plantillas pruebas: para hacer pruebas. blog: si incluimos un sistema de blogs En resumen los archivos deben de estar perfectamente ordenados.

Estilo y reglas de escritura de código PHP

Nombres de variables Los nombres deben ser descriptivos y concisos. No usar variables de una letra salvo para bucles ($t). Siempre es mejor saber que hace una variable con sólo conocer su nombre. Esto aplica para los nombres de variables, funciones, argumentos de funciones y clases. Todos los nombres deben estar en minúscula (Excepto con las clases, donde la primera letra debería de ser mayúscula). En caso de usar más de una palabra, ésta será separada por un signo de underscore "_". En las funciones, es importante que el nombre denote su función inmediatamente. De igual manera, en los parámetros de las funciones queremos saber inmediatamente que estamos usando. Correcto: alta_usuario($login, $password); Erróneo: alta($l, $p); Siempre incluir corchetes Correcto: if ($sigo) { ejecuto(); } Erróneo: if ($sigo) ejecuto(); Debemos poner los corchetes o todos en una sola línea o separados y con comentario de dónde se abre y se cierra if ($sigo) { ejecuto(); } if ($sigo) { ejecuto();... } // del if de sigo Poner espacios entre signos Debemos incluir siempres espacios a ambos lados.de los signos Esto está mal: Correcto: $a = $a + 1; $cad = $cad . " "; Erróneo: $a=$a+1;$cad=$cad." "; Números dentro del código No dedemos de meter números (como constante) dentro del código, si estamos en este caso debemos definir la constante y no meter el número (si lo hacemos es una gochada y habrá que meter el comentario OJO): Correcto: $a = $a * ´INCREMENTO´; Erróneo: $a = $a * 10; Variables sin inicializar Siempre debemos comprobar si las variables estan seleccionadas con isset en aquellas variables de las que no tenemos el control (vienen de un _GET o de una variable)

Comentarios en las funciones
Todas las funciones deben tener un comentario, antes de su declaración, explicando que hacen. No debería ser preciso analizar el código de una función para conocer su utilidad. Tanto el nombre como el comentario que acompañe a la función deben bastar para ello, en ese comentario hay que documentar los parámetros si no son lo suficientemente claros.

Dentro de las funciones los procesos deben de estar comentados (es mejor pasarse que quedarse corto) de tal manera que otro programador pueda entender de forma rápida lo que hace el código sin tener que analizarlo.

Clases
Las clases serán colocadas en un archivo .php aparte, donde sólo se colocará el código de la clase. El nombre del archivo será el mismo del de la clase. En lo posible, procurar que los nombres de clase tengan una sola palabra.

Las clases siguen las mismas reglas de las funciones, por tanto, debe colocarse un comentario antes de la declaración de la clase explicando su utilidad.

Gochadas
Si por prisa o necesidad hacemos una gochada en el código y somos conscientes de ella debe de ser comentada para que otra persona los pueda buscar rápidamente y poder reemplazarlos por soluciones mejores. En el comentario hay que introducir la cadena OJO así como el motivo por el que se ha usado esa solución y posibles mejoras.

Ubicación de archivos
En proyectos web o aplicaciones, se clasificarán los archivos en carpetas

/ Carpeta raiz: Aquí irán los archivos .php a los que accede el usuario directamente, interfaz, etc. js: contiene el javascript Connections: Las conexiones con la base de datos intranet: Contenido de intranet. templates: para el sistema de plantillas pruebas: para hacer pruebas. blog: si incluimos un sistema de blogs

En resumen los archivos deben de estar perfectamente ordenados.

Estilo y reglas de escritura de código PHP

Nombres de variables
Los nombres deben ser descriptivos y concisos. No usar variables de una letra salvo para bucles ($t). Siempre es mejor saber que hace una variable con sólo conocer su nombre. Esto aplica para los nombres de variables, funciones, argumentos de funciones y clases.

Todos los nombres deben estar en minúscula (Excepto con las clases, donde la primera letra debería de ser mayúscula). En caso de usar más de una palabra, ésta será separada por un signo de underscore "_".

En las funciones, es importante que el nombre denote su función inmediatamente. De igual manera, en los parámetros de las funciones queremos saber inmediatamente que estamos usando.

Correcto: alta_usuario($login, $password); Erróneo: alta($l, $p);

Siempre incluir corchetes

Correcto: if ($sigo) { ejecuto(); } Erróneo: if ($sigo) ejecuto();

Debemos poner los corchetes o todos en una sola línea o separados y con comentario de dónde se abre y se cierra

if ($sigo) { ejecuto(); } if ($sigo) { ejecuto();... } // del if de sigo


Poner espacios entre signos

Debemos incluir siempres espacios a ambos lados.de los signos

Esto está mal:

Correcto: $a = $a + 1; $cad = $cad . "
"; Erróneo: $a=$a+1;$cad=$cad."
";

Números dentro del código
No dedemos de meter números (como constante) dentro del código, si estamos en este caso debemos definir la constante y no meter el número (si lo hacemos es una gochada y habrá que meter el comentario OJO):

Correcto: $a = $a * ´INCREMENTO´; Erróneo: $a = $a * 10;

Variables sin inicializar
Siempre debemos comprobar si las variables estan seleccionadas con isset en aquellas variables de las que no tenemos el control (vienen de un _GET o de una variable)

Otras noticias
15 may 2017

Protegerse del ransonware

"El único sistema verdaderamente seguro es uno que esté apagado, metido en un bloque de hormigón y sellado en una habitación aislada con plomo y con guardias de seguridad – y aún así, tengo mis dudas"

Gene Spafford


16 feb 2017

Presentación de la plataforma Areas Empresariales Gijón

Esta semana ha tenido lugar la presentación de una nueva plataforma web que facilita la búsqueda de una ubicación en nuestra ciudad. Ticmedia ha colaborado en el desarrollo de la nueva web.