Boas práticas - HCI - Base de conhecimento
Boas práticas é uma expressão derivada do inglês best practice, a qual denomina técnicas identificadas como as melhores para realizar determinada tarefa.
1 CamelCase
2 Convenção para nomear Componentes visuais
3 Convenção para nomear variáveis, classes e métodos
4 Princípio da responsabilidade unica
CamelCase é a denominação em inglês para a prática de escrever as palavras compostas ou frases, onde cada palavra é iniciada com maiúsculas e unidas sem espaços. É um padrão largamente utilizado em diversas linguagens de principalmente nas definições de classes e objetos.
Existem duas formas de classificá-la: a primeira é conhecida como UpperCamelCase (de letra inicial maiúscula, também conhecida como PascalCase) e a segunda lowerCamelCase (de letra inicial minúscula).
Está de acordo com a norma lowerCamelCase palavras compostas iniciadas por letras minúsculas. Usa-se tal. na programação, ao definir variáveis e métodos.
Exemplos: nomeCompleto, valorDesconto, tipoCliente.
Está de acordo com a norma UpperCamelCase (que também pode ser chamada de PascalCase) aquelas iniciadas por letras maiúsculas. Usa-se tal, na programação, na definição de classes em orientação a objetos.
Exemplos: CalculaDesconto, ValidaEmail, ImprimeCadastro, EnviarNotaFiscal.
Convenção para nomear Componentes visuais
Os campos visuais devem ser nomeados contendo o sufixo de 3 letras cujo conteúdo será a abreviação do tipo de elemento seguido pelo seu nome no banco de dados caso seja um componente DBAware ou pela sua função caso seja um componente simples, exemplo : edtId, edtAtualizadoEm, edtAtualizadoPor
Convenção para nomear variáveis, classes e métodos
As variáveis devem ser iniciadas pela abreviação do seu tipo, e precedido pelo seu nome. O prefixo e o sufixo da váriavel deve ser separado por um underline (_), o nome da objeto deve seguir o formato UpperCamelCase.
str_NomeFantasia: string;
int_Idade: Integer;
bln_ChavePrimaria: boolean;
cds_NotaFiscal; TClientDataSet;
As proprieades devem ser UpperCamelCase, a variavel de Leitura de uma proporiedade deve sempre começar com F, a função de leitura deve começar com get, a variavel de escrita deve sempre ser uma função começada com set
property Tipo: TFieldType read FTipo write SetTipo;
property Tamanho: integer read FTamanho write SetTamanho;
property Valor: Variant read FValor write SetValor;
property Primary: Boolean read FPrimary write SetPrimary;
Property Visibilidade: TVisibilidade read FVisibilidade write SetVisibilidade;
property Permissao: TTipoPermissao read FPermissao write SetPermissao;
property ValorIniciado: Boolean read FValorIniciado;
Princípio da responsabilidade unica
O princípio da responsabilidade única é um dos princípios SOLID. Os princípios SOLID, são uma série de cinco princípios introduzidos por Robert C. Martin( Uncle bob ),como boas práticas de design de software. O princípio da responsabilidade única, foca na preocupação de que uma classe tenha seu papel e venha desempenhar somente ele de forma eficiente.