Consulta De La Semana

Guía de estilo de programación




Introducción


El est ilo de pro gramació n so n las series de co nvencio nes seguidas al desarro llar có digo f uent e en un det erminado lenguaje de pro gramació n.

Est a guía describe las co nvencio nes usadas para el desarro llo en PHP aunque se pueden ext ender perf ect ament e a o t ro s lenguajes co n sint axis similar.

El est ilo de programació n descrit o en est a guía es só lo una reco mendació n, aunque se inst a f ervient ement e a su ut ilizació n para garant izar que t o do el có digo f uent e generado po r varias perso nas t enga un est ilo similar co n lo que se co nsigue que las revisio nes de có digo ent re lo s dist int o s pro gramado res sea mucho más sencilla.


Estilo genérico usado


Dent ro de lo s est ilo smás genérico s de pro gramació n, se usará el est ilo BSD KNF (BSD Kernel
No rmal Fo rm) y se parece mucho al est ilo K&R.

No se debería usar
No se deberían usar lo s siguient es est ilo s de pro gramació n: El est ilo Allman .
El est ilo Whit esmit hs. El est ilo GNU.
La no t ació n Húngara.
La no t ació n de no mbres de element o s de varias palabras co n barra baja (_).Términos usados


Camel Case

Es la práct ica de escribir f rases o palabras co mpuest as eliminando lo s espacio s y po niendo en mayúscula la primera let ra de cada palabra.

Lower Camel Case

Similar al Camel Case só lo que la primera let ra de la primera palabra es t ambién en minúscula. Po r ejemplo , la f rase "generar dat o s aleat o rio s" pasada a lowerCamelCase sería"generarDat o sAleat o rio s".

Upper Camel Case

Similar al Camel Case siendo la primera let ra de la primera palabra en mayúscula. Po r ejemplo , la f rase "generar dat o s aleat o rio s" pasada a UpperCamelCase sería "GenerarDat o sAleat o rio s".

Palabras reservadas


Las palabras reservadas del lenguaje así co mo las co nst ruccio nes que se asimilan a f uncio nes
(array(), list(), et c.) seescribirán t o das en minúsculas.

Indentación (sangrado)


La indent ació n o sangrado debe ser hecha mediant e t abulacione s y no se deben insert ar espacio s. Se reco mienda que el t amaño de las t abulacio nes sea de 4 espacio s aunque est o queda a o pció n del pro gramado r.

Variables


Las variables usadas en cualquier aplicació n deben t ener no mbres que las ident if iquen,es decir, no mbres co mo "a", "b" o "c" no se deberían usar sino que deberían t ener un no mbre co herent e co n co n lo que co nt ienen. En el siguient e ejemplo lo s no mbres de las variables so n co rt o s po r lo que no se ident if ica su signif icado :

























































Código Fuente

$a =0, $b = 0, $c = 0;
if($a > 10 && $b > 20 && $c > 30) {
return true;
} else {
return false;
}


Est e ejemplo debería ser:


Código Fuente

$hora = 0, $minuto = 0, $segundo = 0;
if($hora > 10 && $minuto > 20 && $segundo > 30) {
return true;
} else {
return false;
}


Só lo en el caso de que la variable sea lodemasiado genérica para no t ener un no mbre co ncret o (po r ejemplo el índice de un bucle) ést a se declarará co n el no mbre de "i" siguiendo el o rden alf abét ico en caso de vario s bucles anidado s ("i", "j", "k", .).

Lo s no mbres largo s de las variables se escribirán en lowerCamelCase.

Variables especiales


Exist en variables que no so n variables de t ipo simple sino que so n compuest as, po r ejemplo , lo s arrays y las est ruct uras.

En PHP no exist en est ruct uras ya que gracias a lo s arrays aso ciat ivo s no so n necesarias. Para crear un array vacío , la sint axis es la est ándar:
Código Fuente

$miArray = array();



Para crear un array mo no dimensio nal, la sint axis sería la misma que la ant erio r:




Código Fuente

$miArray =...