PHP - Padrão de Codificação

Cada empresa segue um padrão de codificação diferente com base em suas melhores práticas. O padrão de codificação é necessário porque pode haver muitos desenvolvedores trabalhando em módulos diferentes, portanto, se eles começarem a inventar seus próprios padrões, o código-fonte se tornará muito difícil de gerenciar e será difícil manter esse código-fonte no futuro.

Aqui estão várias razões pelas quais usar especificações de codificação -

Seus programadores pares precisam entender o código que você produz. Um padrão de codificação atua como o projeto para toda a equipe decifrar o código.
A simplicidade e a clareza alcançadas por uma codificação consistente evitam erros comuns.
Se você revisar seu código depois de algum tempo, será fácil entendê-lo.
Seu padrão da indústria é seguir um determinado padrão para obter mais qualidade em software.

Existem algumas diretrizes que podem ser seguidas durante a codificação em PHP.

Indenting and Line Length- Use um recuo de 4 espaços e não use nenhuma guia porque computadores diferentes usam configurações diferentes para a guia. É recomendável manter as linhas com aproximadamente 75-85 caracteres para melhor legibilidade do código.
Control Structures- Incluem if, for, while, switch, etc. As instruções de controle devem ter um espaço entre a palavra-chave de controle e o parêntese de abertura, para distingui-las das chamadas de função. Recomendamos que você sempre use chaves, mesmo em situações em que são tecnicamente opcionais.

Examples

if ((condition1) || (condition2)) {
   action1;
}elseif ((condition3) && (condition4)) {
   action2;
}else {
   default action;
}

Você pode escrever instruções switch da seguinte forma -

switch (condition) {
   case 1:
      action1;
      break;
   
   case 2:
      action2;
      break;
         
   default:
      defaultaction;
      break;
}

Function Calls- As funções devem ser chamadas sem espaços entre o nome da função, o parêntese de abertura e o primeiro parâmetro; espaços entre vírgulas e cada parâmetro, e nenhum espaço entre o último parâmetro, o parêntese de fechamento e o ponto-e-vírgula. Aqui está um exemplo -

$var = foo($bar, $baz, $quux);

Function Definitions - As declarações das funções seguem o "estilo BSD / Allman" -

function fooFunction($arg1, $arg2 = '') {
   if (condition) {
      statement;
   }
   return $val;
}

Comments- Comentários de estilo C (/ * * /) e comentários C ++ padrão (//) são adequados. O uso de comentários de estilo Perl / shell (#) é desencorajado.
PHP Code Tags- Sempre use <? Php?> Para delimitar o código PHP, não o <? ?> taquigrafia. Isso é necessário para a conformidade do PHP e também é a maneira mais portátil de incluir código PHP em diferentes sistemas operacionais e configurações.
Variable Names -
- Use todas as letras minúsculas
- Use '_' como separador de palavras.
- Variáveis globais devem ser precedidas de um 'g'.
- As constantes globais devem ser todas em maiúsculas com separadores '_'.
- Variáveis estáticas podem ser anexadas a 's'.
Make Functions Reentrant - As funções não devem manter variáveis estáticas que evitem que uma função seja reentrada.
Alignment of Declaration Blocks - Bloco de declarações deve ser alinhado.
One Statement Per Line - Deve haver apenas uma instrução por linha, a menos que as instruções estejam intimamente relacionadas.
Short Methods or Functions - Os métodos devem se limitar a uma única página de código.

Pode haver muitos outros pontos que devem ser considerados ao escrever seu programa PHP. Acima de tudo, a intenção deve ser ser consistente em toda a programação do código e isso só será possível quando você seguir qualquer padrão de codificação. Você pode usar seu próprio padrão se quiser algo diferente.

↰ Previous page Next page ↱