Codificação

Quem desejar colaborar com a codificação do sistema deverá observar alguns padrões de escrita para as próximas versões do sistema.

O Walker de Alencar disponibilizou em seu site pessoal uma série de padrões para uma codificação mais clara e organizada observando os métodos utilizados em várias linguagens para produzir codigos de alta qualidade.

O uso destes padrões é OBRIGATÓRIO para qualquer contribuição, veja  o artigo PHP Coding Standards em http://www.walkeralencar.com/PHPCodeStandards.pdf

Os códigos atuais que ainda não estejam atendendo estes padrões serão alvo de revisões!!!

 

Padrões de Codificação 

  1. Não é permitido o uso de "short Tags"  <? Use Somente "long Tags" <?php
  2. Todos os arquivos devem ser codificados em "UTF-8". Nunca use outro padrão de codificação
  3. A indentação deve ser de 4 espaços. Não é permitido o uso de "TABS"
  4. O final de linhas deve seguir o padrão UNIX ou seja devem terminar com um simples "linefeed". Nunca use "CRLF" (padrão windows)
  5. Os nomes de funções (Métodos) são alfanumericos e devem observar o padrão "camelCase" e nunca conter espaços ou outros simbolos.
  6. Os nomes de variáveis somente devem conter caracteres alfanumericos, "underscore", espaço e outros simbolos não são permitidos.