Desenvolver PHP a pensar no futuro

Nem todos os programadores de PHP desenvolvem a pensar no futuro. Quer estejam a desenvolver sozinhos ou em equipa é sempre bom obedecer a algumas regras que se devem manter em todo o projecto, assim como documentar o nosso código.

Aqui ficam algumas dicas que actualmente aplico em todos os meus projectos.

Indentação do código
Se não temos código legível como o vamos alterar no futuro? É por isso que a indentação é muito importante.

1. <?php if (empty($var)) {echo 'Está vazio';} ?>

No exemplo acima temos tudo numa linha de código apenas. Com pouco texto é perceptível, mas com uma função mais complexa seria o caos. Se utilizarmos indentação o código fica perceptível quer por nós quer por quem visualize o código posteriormente.

1. <?php
2. if (empty($var)) {
3.    echo 'Está vazio';
4. }
5. ?>

Pessoalmente não aconselho a efectuar a indentação com espaços, é preferível usar tabulações pois o seu tamanho pode ser definido directamente na aplicação que estamos a usar para editar o código. O número de tabulações entre linhas de código fica ao vosso critério, mas seja qual for lembrem-se de o utilizarem sempre para que o código fique igual em todo o projecto.

Nomes de funções e variáveis
O PHP é uma óptima linguagem pois deixa-nos programar da forma a que mais nos adaptamos. Isto tem um custo associado, e por vezes as nossas escolhas nos nomes de funções e variáveis podem não ser as mais correctas.

1. $variable_name
2. $VariableName
3. $variableName
4. $variablename

As primeiras três linhas são bons exemplos de como dar um nome a uma variável ou função. A primeira é normalmente a mais utilizada, usando um underscore (_) em substituição de um espaço.

A quarta linha é um mau exemplo porque o nome da variável fica mais confuso e torna-se mais difícil ler o seu nome.

Eu opto sempre por colocar o nome de variáveis e funções na forma CamelCase com a primeira letra minúscula (mixedCase) tal como na terceira linha do exemplo acima.

Números mágicos
Guardar um número como ID em vez de uma palavra numa base de dados torna a indexação mais rápida e ocupa menos espaço em disco, tornando a base de dados mais eficiente. Fazer o mesmo em programação é o oposto.

1. <?php
2. if ($var == 3) {
3.    // Corre função
4. }
5. ?>

Visualizando o código ficamos sem saber a que corresponde o algarismo 3, um número mágico. Se definirmos uma palavra ao nosso algarismo tornamos o código mais perceptível e fácil de manter caso o valor deste algarismo altere.

1. <?php
2. define('ACTIVO', '3');
3. if ($var == ACTIVO) {
4.    // Corre função
5. }
6. ?>

Podemos assim definir uma palavra que corresponde ao algarismo, e se desejarmos basta alterar num local o algarismo correspondente e todo o nosso código vai saber que ACTIVO para a corresponder a um novo número.

Comentários
Colocar comentários no código a documentar o que cada função faz é crucial. Não apenas para quando trabalhamos em grupo mas também quando são projectos individuais. Certamente com o código fresco na cabeça se lembram do que cada pedaço de código faz, mas se necessitarem de alterar algo após 6 meses ou 1 ano certamente vão agradecer que o código esteja devidamente documentado.

Sempre que declararem uma função é bom explicar o que ela faz e explicar o que cada argumento recebe.