{ 2008 02 13 }

Melhores práticas para programar em symfony (Coding Standards)

Práticas

  • Nunca usar tabulação nos códigos. A indentação é sempre feita com 2 espaços em branco.
  • Não colocar espaços depois de abrir e fechar parenteses.

 if ($reqvalue _getRequestValue($name))    correto
 if ( $reqvalue _getRequestValue($name) )  incorreto
 
  • Usar camelCase, e não underscores, para variáveis, funções e nomes de métodos, exeto para nomes de helpers.
  • Chaves sempre tem uma linha única só para elas.
  • Não termine arquivos de bibliotecas (lib/) com o tradicional ?>. Ele na verdade não é obrigatório e caso venha a ter algum espaço depois (”?> “) ocorrerá erro.
  • No corpo das funções é bom que o “return” tenha um destaque para melhorar a leitura. Para isso, deixe uma linha em branco antes dele.

function fooFunction() {
  if (condition2 || condition3) {
    statement1;
    statement2;    

    return 1;
} else {
    defaultaction;
}
  return null;
}
  • Os comentarios de uma linha devem vir sempre desse jeito

// primeiro espaço, sem quebra de linha se ficar longo`

  • Evitar de tratar variáveis dentro de strings.

$string = ‘algo’;
$new_string = "$string é legal!";   // ruim
$new_string = $string . ‘ é legal!’; // melhor
 

Postado por pedro on Wednesday, February 13th, 2008, at 4:40 am, and filed under php, symfony.

You can post a comment, or trackback from your site.