PHP - Boas maneiras na hora de programar (parte 2)

Neste segundo artigo da série iremos tratar de alguns padrões de código que ainda faltam, tais como declaração de funções, uso de funções, comentários etc.

por Marcelo Pereira Fonseca da Silva

Neste segundo artigo da série iremos tratar de alguns padrões de código que ainda faltam, tais como declaração de funções, uso de funções, comentários etc.

Falaremos agora como trabalhar com chamada de funções dentro do seu script PHP.

O padrão especificado é o que segue:

"Funções devem ser chamadas SEM espaços entre o nome da função, o parênteses de abertura e o primeiro argumento, os demais argumentos devem conter um espaço entre ele e a vírgula anterior"

Supondo a seguinte situação:

Tenho uma função chamada "melancia" na qual passo 3 argumentos

<?php
$variavel = melancia($cor, $valor, $peso);
?>

Esta seria a maneira correta de usar a função descrita acima.

Mudando um pouco de assunto um ponto necessário em qualquer programação são as variáveis, e para usá-las naturalmente há uma maneira de deixar sua leitura mais fácil.

"Use espaços para igualar o sinal que atribui valor às variáveis"

Vamos ao exemplo:

<?php
// supondo um script...
$cor = "amarelo";
$tamanho = "gigante";
?>

Este código inicialmente parece correto, mas poderia ser melhorado usando o padrão especificado pelo pessoal da PEAR

<?php
// supondo um script...
$cor     = "amarelo";
$tamanho = "gigante";
?>

Assim fica bem mais fácil a leitura de variáveis dentro do seu script.

Para declarar funções existe um padrão que é como segue:

No manual fala sobre a convenção "one true brace" para uso em funções

<?php
function minha_funcao($arg1, $arg2 = "")
{
    if (condição) {
        comandos aqui;
    }
    return $val;
}
?>

O último ponto que este artigo da série irá tratar é sobre as tags PHP e Comentários.

Sobre as tags PHP como visto nos dois artigos da série, é usado sempre <?php para abrir o código PHP.

Isso vem também de uma regrinha da PEAR que fala para usar sempre <?php e ?> para delimitar o código PHP, NUNCA usar <? e ?>, e falam também que isso é um requisito sobre pacotes que serão incorporados à PEAR.

Os comentários são um ponto especial na programação, o ponto mais importante.

Eles seguem as especificações do PHPDoc http://www.phpdoc.org/ que são similares ao JavaDoc.

É interessante ressaltar somente que você é encorajado a usar // para comentários de linha e /* */ (no padrão do PHPDoc) para comentários de bloco e você é fortemente desencorajado a usar # para comentários de linha no estilo perl.

Exemplo:

<?php
Class teste {
     /**
     * É muito importante documentar meu código
     * por isso estou fazendo da maneira correta.
     */
    function() 
    {
    }
}

?>

Existem algumas "tags" precedidas por "@" que são padrões do PHPDoc para documentar corretamente é interessante usá-las.

Abraços,

Marcelo Pereira Fonseca da Silva