Buenas prácticas en PHP

13Jul10

Miguel, mi buen socio y mejor amigo ha estado impartiendo las dos semanas anteriores el curso de PHP Avanzado (programa en pdf) de Jedi (Junior Empresa). Se trata de unos cursos de verano que ofrece esta organización adherida a la UPC. Yo le he estado echando un cable a modo de becario.

Estuvo repasando en una de las sesiones de teoría las buenas prácticas a la hora de escribir código en PHP. A continuación las recopilo, pues aunque algunas sean obvias y parezcan básicas creo que es importantes tenerlas en cuenta, sobretodo si se trabaja en grupo. Además, PHP es tan flexible que permite hacer muchas marranadas.

1) Usar “soft tabs” (seguido de espacios) o bien configurar el IDE para que el botón de tabulación se transforme automáticamente en X espacios (normalmente 4). Esto evita los típicos problemas de indentado al leer el código en distintos editores de texto.

2) La llave que abre los bloques “{” debe ir en la linea siguiente de la declaración.

3) Pautas para nombrar clases:

  • Letra inicial en mayúscula.
  • Resto de nombre se escribe en CamelCase.
  • Se usa “_” para indicar la capa o paquete en la que se encuentra la clase (normalmente el folder).

4) Pautas para nombrar variables:

  • Poner nombres entendibles, explicativos y concisos
  • Usa camelCase

5) Pautas para nombrar constantes:

  • Toda en mayúscula
  • Distintas palabras separadas por “_”

6) Pautas para nombrar métodos:

  • Si es privado, añadir el “_” delante del nombre de la función

7) No usar “open tag” <?.  Estos pueden ser confundidos con el inicio de código <?xml. En su lugar, usar siempre <?php.

8) Para documentar usar siempre /* */ o //, nunca usar #.

Estas son algunas. Seguramente haya mas … si alguien quiere completar la lista lo añadiré sin ningún problema.

Editado: Añado algunas más que he recibido mediante los comentarios de CPS 2.0.

9) Los string literales van entre comillas simples:

$a = 'Example String';

Nota: Yo uso por defecto las comillas dobles, por el tema de los apostrofes en catalán. Lo importante es definir un estándar.

10) En la concatenación usar espacio antes y despues de “.”:

$company = 'Zend' . ' ' . 'Technologies';

11) Para concatenacion multilinea, poner el “.” en la linea siguiente y tabularlos a la altura de “=”:

$sql = "SELECT `id`, `name` FROM `people` "
. "WHERE `name` = 'Susan' "
. "ORDER BY `name` ASC ";

Muchas gracias por la colaboración ;) !

There is 1 comment in this article:

  1. 30/07/2010CPS 2.0 say:

    Los string literales van entre comillas simples:
    $a = 'Example String';

    Los string literales con aportrofes entre comillas dobles:
    $sql = "SELECT `id`, `name` from `people` "
    . "WHERE `name`='Fred' OR `name`='Susan'";

    Para sustitucion de variables en string, se permiten estas dos formas:
    $greeting = "Hello $name, welcome back!";
    $greeting = "Hello {$name}, welcome back!";

    En la concatenación user espacio antes y despues de “.”
    $company = 'Zend' . ' ' . 'Technologies';

    Para concatenacion multilinea, poner el “.” en la linea siguiente y tabularlos a la altura de “=”:
    $sql = "SELECT `id`, `name` FROM `people` "
    . "WHERE `name` = 'Susan' "
    . "ORDER BY `name` ASC ";

    Conosco varias mas, por cuestion de tiempo hoy les dejo estas, pero publicare un articulo completo en Newbie.cl.

    Saludos

    CPS 2.0

Write a comment: