Visão geral

Escopo

Este documento fornece instruções para formatação e documentação de código a indivíduos e times que contribuem com o Zend Framework. Muitos desenvolvedores que utilizam o Zend Framework acham que estes padrões são igualmente importantes para que seu estilo de codificação permaneça consistente com todo o código do Framework. Vale também notar que é necessário esforço significativo para especificar padrões de codificação por completo.

Nota

Por vezes, desenvolvedores consideram o estabelecimento de um padrão mais importante do que o padrão sugere de verdade ao nível mais detalhado de design. As instruções nos padrões de codificação do Zend Framework absorvem práticas que funcionaram bem no projeto do Framework. Você pode alterar tais padrões ou usá-los "as is" de acordo com os termos de nossa licença.

Os tópicos abordados nos padrões de codificação do Zend Framework incluem:

  • Formatação de arquivos PHP

  • Convenções de nomenclatura

  • Estilo de codificação

  • Documentação em linha de código

Objetivos

Padrões de codificação são importantes em qualquer projeto de desenvolvimento, mas são particularmente importantes quando muitos desenvolvedores estão trabalhando no mesmo projeto. Eles ajudam a garantir que o código possua alta qualidade, poucos bugs e possam ser facilmente mantidos.