Mudanças entre as edições de "Padrão de programação"

De Supel Wiki
Ir para: navegação, pesquisa
(Criou página com 'Métodos: </br> * Nome de métodos devem ser em português; * Seu nome deve revelar oque ele irá realizar ,"sem miséria do seu tamanho"; * Nomes extenso com conjuntos de pal...')
 
 
(2 revisões intermediárias pelo mesmo usuário não estão sendo mostradas)
Linha 1: Linha 1:
 +
Classes:</br>
 +
* 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 : </br>
 +
*Declaração de Interfaces devem levar o prefixo “I” e nomenclatura como uma classe;
 
Métodos: </br>
 
Métodos: </br>
 
* Nome de métodos devem ser em português;
 
* Nome de métodos devem ser em português;
* Seu nome deve revelar oque ele irá realizar ,"sem miséria do seu tamanho";
+
* 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()";  
 
* 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 ;
 
* Devem ser curtos , e com poucas responsabilidades . Se necessário criar sub métodos com responsabilidades únicas ;
Linha 9: Linha 18:
 
* Nome de variáveis devem ser em português;
 
* Nome de variáveis devem ser em português;
 
* Seu nome deve revelar seu sentido ,"sem miséria de tamanho";
 
* Seu nome deve revelar seu sentido ,"sem miséria de tamanho";
 +
* Abreviações só se for reconhecida por todos ;
 +
* Lista sempre ordenada ;
  
 
Comentários :</br>
 
Comentários :</br>

Edição atual tal como às 17h08min de 22 de março de 2019

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;