Sugestões de Padrão de Codificação Aplicado à Programação Comercial

From AdonaiMedrado.Pro.Br
Revision as of 22:25, 6 September 2008 by Adonaimedrado (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search


Sugestão 1

  • Crie ou adote um padrão de codificação e siga-o em todo o código.
  • Caso existe uma boa razão para não seguir em determinado momento, documente esta razão e discuta com a equipe.

Sugestão 2

  • Código de terceiros devem ser referenciados e postos em arquivos separados.
    • Informe nome do autor e link para site original.
    • Não se esqueça de verificar a licença do código que está utilizando bem como a compatibilidade da sua própria licença.

Sugestão 3

  • Adote o padrão preferencial de nomes em inglês para seus identificadores.
  • Caso opte por um padrão em outra língua siga este padrão durante todo o programa.

Sugestão 4

  • Não utilize maiúsculas e minúsculas para diferenciar os identificadores no seu código.
    • Exemplo: não crie uma variável v e outra V no mesmo escopo.

Sugestão 5

  • Evite o uso de abreviaturas, ou utilize-as com bastante cuidado.

Sugestão 6

  • Não use underscore no nome das variáveis. Siga o padrão abaixo.

Sugestão 7

  • Dê nome aos identificadores conforme seu significado, não conforme seu tipo.

Sugestão 8

  • Defina um padrão para os nomes dos pacotes ou espaço de nomes.

Sugestão 9

  • Não adicione em classes, registros ou estruturas o sufixo dos seus tipos.

Sugestão 10

  • Coloque o prefixo I nos nomes das interfaces.

Sugestão 11

  • Utilize verbos para nomes dos eventos e nomes ou frase para identificadores.

Sugestão 12

  • Coloque o sufixo Exception para classes de exceção.

Sugestão 13

  • Use a construção this somente quando necessário para resolver ambigüidades.

Sugestão 14

  • Declare e inicialize as variáveis próximo de onde for utilizá-las.
  • Sempre que possível inicialize as variáveis no momento da declaração.

Sugestão 15

  • Não altere a variável de loop do for dentro do bloco de repetição.

Sugestão 16

  • Atualize as variáveis de loop próximo ao local onde a condição de loop é especificada.

Sugestão 17

  • Todo switch (case) deve ter o default (else).
  • Caso a ocorrência do default deveria ser impossível, lance uma exceção em sua implementação.

Sugestão 18

  • Evite múltiplos pontos de retorno (múltiplos returns).

Sugestão 19

  • Evite o uso de instrução de seleção (if/switch) caso uma atribuição simples seja possível.

Sugestão 20

  • Permita que as propriedades sejam setadas em qualquer ordem.

Sugestão 21

Um construtor deve deixar o objeto em um estado de totalmente inicializado.

Sugestão 22

  • Acorde o número de espaço de tabulação e onde/quando deve ser utilizado o espaçamento e a quebra de linha.
    • Quatro é um bom número de espaços para tabulação.

Sugestão 23

  • Use uma ferramente automática para verificação do padrão.

Sugestão 24

  • Se perceber que está utilizando um padrão que está dificultando a tarefa, pare e acorde um novo padrão e um método de transição.