Posterous theme by Cory Watilo

Guía de estilo para la programación

En un intercambio de "tweets" con @ala_747 y @happywebcoder sobre lo duro que es retomar un código programado meses atrás y lo bueno que es utilizar una manera de programar para facilitar la legibilidad del código, se me ha ocurrido compartir mi humilde "guía de estilo" que trato de utilizar en mis desarrollos y que he ido "perfeccionando" a lo largo de los trabajos por los que he ido pasando.

Variables

m_var : Variables miembro

l_var : Variables locales

in_var : Variables parámetros de función

out_var : Variables pasadas por referencia parámetros de función

c_var : Variables que se pasan del Controlador a la Vista (En entornos MVC)

Constantes

CONS_CONSTANTE : En mayúsculas

Métodos

Primera letra en minúscula y siguientes palabras primera letra en mayúscula.

nombreMetodo: Métodos públicos o protected

_nombreMetodo : Métodos privados

Identación

Reemplazo tabulaciones por 4 espacios.

Espacios, llaves, etc

Me gusta espaciar mucho el código, sobre todo entre parámetros, condiciones de sentencias, etc. Por ejemplo:

if( $l_var == true ){
}

while( $l_var == true && $l_var2 != false){
}

$this->nombreMetodo( $l_var, $l_var2 );

Arrays

Las arrays sobre todo cuando son multidemensionales pueden complicar su lectura así que a mi me va muy bien la siguiente estrcutura:

$matrix = array(

    'key1' => array(

        'value11',

        'value12'

   ),

   'key2' => array(

        'ke21' => array(

            'key211' => 'value211'

        )

   ),

   'key3'

);

Seguro que me he dejado algunas cosas, así que iré ampliándolo. Y por supuesto cualquier aportación será bien recibida.