PHP Coding Standard, boas maneiras no código: Formatação do arquivo, Identação e Tamanho de linha

PHP como algumas outras linguagens, da ao programador uma liberdade maior na hora da programação, podendo ser feita a mesma coisa de várias maneiras. Porém nem sempre isso é bom, principalmente quando se trabalha em um projeto com multi programadores, cada programador desenvolvendo de uma maneira, escrevendo diferente um do outro, já viu o carnaval que é o resultado final.

Para solucionar isso, existem os code standard, padrões de código, normalmente um framework, um CMS, ou algum sistema segue 1 padrão de código (ou pelo menos se espera que siga), é o caso do Zend Framework, CakePHP e do Drupal.

Com base, nos padrões dos 2 frameworks, e do CMS citado acima, e com alguma experiencia que venho a ter, vou relatar em alguns posts algumas boas práticas de escrever o código PHP.

1 – Formatação do arquivo PHP:

1.1 – Tag de abertura:

O PHP tem suporte à short tag de abertura < ?, porém não é uma opção default em algumas configurações de servidor, logo é recomendado sempre usar a tag de abertura completa < ?php.

1.2 - Identação:

O padrão de identação varia nas referencias citadas acima, porém o mais comum de se achar, e ao mesmo tempo que da uma melhor visão é 4 espaços para cada identação. Ficando assim:

1
2
3
4
5
6
7

< ?php 
//primeiro nível
    //segundo nível
//primeiro nível
    //segundo nível
        //terceiro nível
?>

Na prática:

1
2
3
4
5
6
7
8
9
10
11

< ?php 
class Cobaia {
 
    public function __construct() {
        if (1 == 1) {
            print 'yeah';        
        }    
    }
 
}
?>

O uso da identação se da, para o programador ter uma melhor visão dos blocos, saber em que bloco se encontra a linha que ele está lendo, da um aspecto visual mais limpo ao código, logo melhora para achar o que é necessário.

1.3 - Tamanho da linha:

O tamanho de cada linha de código no PHP é relativo, mas visualmente falando uma linha pode ter no máximo 80 caracteres, pois é o máximo de visão que quem está lendo o código fonte vai ter, algumas IDE's como o Netbeans, tem uma linha vertical, que demarca essa posição, logo quando sua linha de código ultrapassar ela é melhor termos uma quebra de linha.

Por enquanto era isso no próximo post vamos falar de nomenclatura.