Padrão de programação
Revisão de 17h08min de 22 de março de 2019 por Rafael almeida (discussão | contribs)
Classes:
- As classes devem ser declaradas com o nome do objeto que ela representa;
- Responsabilidade única;
- Utilizar agrupadores (#regions) para separar partes das classes, "Sem problemas";
- Ao renomear itens não esquecer de renomear arquivo e classes;
- Lista de classes devem ser representadas no plural , "EventosDoItem";
- Lista sempre ordenada ;
Interfaces :
- Declaração de Interfaces devem levar o prefixo “I” e nomenclatura como uma classe;
Métodos:
- Nome de métodos devem ser em português;
- Seu nome deve revelar oque ele irá realizar ,auto explicativo ,"sem miséria do seu tamanho";
- Nomes extenso com conjuntos de palavras devem ser destacados com letra MAIÚSCULA ,"GravarPessoaJuridica()";
- Devem ser curtos , e com poucas responsabilidades . Se necessário criar sub métodos com responsabilidades únicas ;
- Não deve conter comentários ;
Variáveis :
- Nome de variáveis devem ser em português;
- Seu nome deve revelar seu sentido ,"sem miséria de tamanho";
- Abreviações só se for reconhecida por todos ;
- Lista sempre ordenada ;
Comentários :
- Manter somente se vier em documentação de Framework ,Plugins e etc;
- Código comentado não funciona ,"Botar Fogo";
- Métodos e variáveis não devem possuir comentários , pois seu nome revela o seu sentido;