Convenções de codificação do sistema

Estabelecer diretrizes que devem ser utilizadas durante a escrita e a manutenção do código-fonte do sistema.

• Todas as constantes devem ter seus nomes escritos em letras maiúsculas;
• Quando o nome de uma constante for composto por mais de uma palavra, estas devem estar separadas pelo caractere '_';
• Constantes que representam nomes de arquivos devem começar com 'NOME_…';
• Constantes que representam pastas devem começar com 'PASTA_…';
• Constantes que representam caminhos completos de arquivos (pasta + nome) devem começar com 'CAMINHO_…';
• Constantes que representam mensagens exibidas ao usuário através de uma caixa de mensagem devem começar com 'MSG_…';

• Todos os nomes de classes devem seguir as convenções da linguagem em relação a capitulação;
• Nomes de classes dinâmicas devem começar com o prefixo 'T' (TAluno, TProfessor, …);
• Nomes de classes estáticas não devem usar prefixos (Exportacao, Mensagem, …);
• Nomes de classes que representam entidades do domínio do problema devem estar sempre no singular (TAluno, TTurmaRegular, …);
• Nomes de classes que representam coleções devem estar sempre no plural (TListaAlunos, TNotas, …);
• Nomes de classes que controlam um módulo específico devem começar com o prefixo 'LG' (TLGAlunos, TLGTurmas, …);