Qualidade de código com PHP

Este artigo apresenta, de forma prática e rápida, como analisar se a codificação esta adequada aos padrões e se como corrigir-la.

Quando atuamos com codificação em equipe é importante seguirmos um padrão para codificação, em PHP existem diversos padrões que podem ser adotados, entre eles temos: Zend, PEAR, PHPCS, SQUIZ etc.
Com base na padronização, veremos um programa que analisa os códigos e outro que padroniza os códigos.

PHPCodeSniffer

O CodeSniffer do PHP é um analista de código, que verifica se a codificação esta seguindo um padrão, e emite um relatório de pontos em que a codificação fere a norma.

Instalação

pear install PHP_CodeSniffer-1.3.0RC1

Sintax:

phpcs opções /diretório/arquivo

Opções
--report = padrão de report (Uso summary e source para erros mais comuns)
-n = omitir warnings
-s = relatório completo com sumário
--standard = padrão a ser adotado (Zend, PEAR, PHPCS, SQUIZ), se for omitido esta opção, o sistema usa como padrão o PEAR
--config-set = Configura o PHPCodeSniffer

Exemplos de uso


phpcs --report=summary /var/www
Verifica o diretório /var/www, ou seja, todo o conteúdo

phpcs --report=summary /var/www/index.php
Verifica apenas o arquivo index.php

O relatório apresentado, demonsta o caminho indicado para que possa ser corrigido.

PHP_Beautifier

O Beautifier é um padronizador de códigos, ótimo para padronização de codigos.

Instalação

pear install PHP_Beautifier-0.1.15

Sintax:

php_beautifie opções /diretório/arquivo.php  /diretório/arquivo_novo.php

Opções

-tn = T é a quantia de espaço por tab a ser utilizada e n indica o numero correspondende
-s = indentamento automático
-r = recursiva, para converter diretórios inteiros
-l = filtros especiais

Exemplo

php_beautifier -t2 -l “Pear()” index.php index_pear.php

converte o index.php utilizando tab = 2 e padrão pear de codificação do arquivo index.php salvando como index_pear.php

Conclusão
Com os dois comandos, é possivel, não somente manter a códificação padronizada, como analisar os códigos de aplicações e as modificações criadas, mantendo a qualidade de codificação.


Artigos relacionados