Mudanças entre as edições de "Guidelines de Implementação"
| Linha 3: | Linha 3: | ||
== '''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 == | == Variáveis == | ||
| Linha 11: | Linha 11: | ||
*O nome da variável tem que ser o mais claro possível. Abreviações não devem ser utilizadas; | *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 ). | *Nomes de variáveis globais devem ser precedidas da letra “g” em minúsculo e undercore (ex: g_line_number ). | ||
| + | |||
| + | == Constantes == | ||
| + | Os nomes das constantes de classe devem ser todos em maiúsculas, com palavras separadas por underscore (“_”).Exemplo: | ||
| + | |||
| + | <font color=#007A00> #define</font> TABLE_WIDTH <font color=#7A0000>90</font> | ||
Edição das 15h27min 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 ).
Constantes
Os nomes das constantes de classe devem ser todos em maiúsculas, com palavras separadas por underscore (“_”).Exemplo:
#define TABLE_WIDTH 90
