Mudanças entre as edições de "Guidelines de Implementação"
(New page: == Introdução == Este documento estabelece o padrão de codificação de códigos-fonte para o projeto SCAE. == '''Regra Número 1''' == Quando você não puder encontrar uma orientaç...) |
|||
| Linha 4: | Linha 4: | ||
== '''Regra Número 1''' == | == '''Regra Número 1''' == | ||
Quando você não puder encontrar uma orientação ou uma regra que se aplique ao seu caso; ou ainda, quando uma regra não se aplicar, ou mais obviamente, ou quando tudo falhar: use o senso comum e verifique os princípios fundamentais. Esta regra prevalece sobre todas as outras. O senso comum é necessário mesmo quando existem regras e orientações. | Quando você não puder encontrar uma orientação ou uma regra que se aplique ao seu caso; ou ainda, quando uma regra não se aplicar, ou mais obviamente, ou quando tudo falhar: use o senso comum e verifique os princípios fundamentais. Esta regra prevalece sobre todas as outras. O senso comum é necessário mesmo quando existem regras e orientações. | ||
| + | |||
| + | == Variáveis == | ||
| + | Os nomes das variáveis devem obedecer às seguintes regras: | ||
| + | *Todas as variáveis devem ser declaradas no início da função. | ||
| + | *Todas as letras devem ser minúsculas, sendo que as palavras são separadas por underscore (_); | ||
| + | *O nome da variável tem que ser o mais claro possível. Abreviações não devem ser utilizadas; | ||
| + | *Nomes de variáveis globais devem ser precedidas da letra “g” em minúsculo e undercore (ex: g_line_number ). | ||
Edição das 15h21min de 19 de fevereiro de 2009
Introdução
Este documento estabelece o padrão de codificação de códigos-fonte para o projeto SCAE.
Regra Número 1
Quando você não puder encontrar uma orientação ou uma regra que se aplique ao seu caso; ou ainda, quando uma regra não se aplicar, ou mais obviamente, ou quando tudo falhar: use o senso comum e verifique os princípios fundamentais. Esta regra prevalece sobre todas as outras. O senso comum é necessário mesmo quando existem regras e orientações.
Variáveis
Os nomes das variáveis devem obedecer às seguintes regras:
- Todas as variáveis devem ser declaradas no início da função.
- Todas as letras devem ser minúsculas, sendo que as palavras são separadas por underscore (_);
- O nome da variável tem que ser o mais claro possível. Abreviações não devem ser utilizadas;
- Nomes de variáveis globais devem ser precedidas da letra “g” em minúsculo e undercore (ex: g_line_number ).
