27 de julho de 2011  //  1 Comentário  //  Categorias: Tutoriais, WordPress

WordPress Coding Standards



É comum – mas não deveria – começarmos um grande projeto tomando os devidos cuidados com a padronização no início, mas ao vermos o prazo estourar, finalizarmos de qualquer maneira. ^^’

Por experiência própria digo que a padronização é uma questão de habito. Você não vai programar mais rápido ou mais devagar se utiliza-la. Alias, ha apenas vantagens pois em uma futura manutenção no sistema, você verá o quão bom é utilizar uma padronização.

Para documentação de comentários e até mesmo da codificação, gosto muito de utilizar a Pear Standards em conjunto com o PHP Documentor.

A cada nova versão do WordPress, vemos a equipe de desenvolvimento cada vez mais preocupada com a padronização da codificação de plugins ou temas. Esta preocupação vem crescendo em muitos outros framework de desenvolvimento, como meu amado o CakePHP, com sua versão 2.0.

O WordPress disponibilizou uma documentação do que se espera de uma codificação “ideal”.

Aspas simples e duplas

Use aspas simples e duplas quando apropriado. Se você não estiver tratando nada na string, use use aspas simples.

Espaçamentos – Indentação

Sua indentação deve sempre refletir uma estrutura lógica. Use tabs reais e não espaços, pois isso permite maior flexibilidade entre clientes. Tabs devem ser utilizadas no inicio das linas e espaços usados no meio das linhas.

Estilo das Chaves

Chaves devem ser usadas em múltiplos blocos:

Loops devem sempre conter chaves para melhorar a legibilidade, e permitir poucas linhas de edição para posteriores correções ou adição de novas funcionalidades:

Uso de espaços

Sempre ponha espaços após as vírgulas e em ambos os lados das atribuições de operadores lógicos como:

Assim como em ambos os lados dos parêntesis de abertura e fechamento de blocos if, elseif, foreach, for e switch:

Quando definindo funções, faça assim:

E quando chamando uma função, faça assim:

Valores de sinalização de argumentos de função auto-explicativos

Prefira valores em string a apenas true e false quando chamar funções.

Já que o PHP não suporta argumentos em forma de nomes, os valores dos sinalizadores não tem significados e toda vez que aparece uma função como essa nós temos que pesquisar pela definição da função. O código pode ficar mais legível se usarmos textos descritivos, ao invés de boleanos:

Conclusão

Estas práticas podem melhorar a sua codificação inclusive para outros frameworks.
Adote uma padronização, crie o habito de utiliza-la e seja feliz! =]

Quer copiar esse post no seu site? Você pode!

Segundo a licença da Creative Commons 3.0 (CC BY SA 3.0) você pode copiar e distribuir esse conteúdo desde que faça menção ao autor original, para isso é só copiar esse código no final do artigo quando for publicá-lo em seu site:

<p>Artigo originalmente publicado em <em>27 de julho de 2011</em> por <strong><a href="http://pedroelsner.com/" title="Pedro Elsner, Profissional de TI - São Paulo">Pedro Elsner</a></strong>: <a href="http://pedroelsner.com/2011/07/wordpress-coding-standards/" title="WordPress Coding Standards">WordPress Coding Standards</a></p>
A não menção ao autor original da obra implicará em cópia e/ou distribuição ilegal de propriedade intelectual, o que é crime segundo a Lei n.º 9.610.
  • Croata

    Dicas importantes !!! Obrigado