Blog do TreinaWeb
Dicas, notícias e informações sobre cursos, programação, webstandards e desenvolvimento web.Posts com a Tag ‘Diretrizes de programação’
-
Diretrizes de programação
22 de April de 2009
Hoje falaremos de um item muito importante para quem é programador ou para quem quer ser um programador, que é Guidelines ou simplesmente diretrizes de programação.
As diretrizes de programação são regras que você deve seguir quando está desenvolvendo para deixar seu código mais legível e facilitar a vida de quem futuramente for dar manutenção no seu código.
PascalCasing
Propriedades e métodos devem seguir a convenção PascalCasing, onde a primeira letra de cada palavra é maiúscula.Exemplo:
CamelCasing
Já os parâmetros e variáveis deve seguir a convenção CamelCasing, onde a primeira letra da primeira palavra deve ser minúscula e das demais palavras devem ser maiúsculas.Exemplo:
Veja que tanto as variáveis e o parâmetro da função estão seguindo as regras do CamelCasing.
Verbos
Segundo as diretrizes de programação todos os métodos devem iniciar com verbos, por exemplo: use Add, se o método for adicionar algo; Set, se for atribuir; e Get, se for pegar algo.Exemplo:
Também é indicado que propriedades booleanas devem ser iniciadas com Has, Can ou Is.
Exemplo:
Uma coisa que vocês devem ter reparado é outra indicação, ou seja, sempre renomeie os métodos, propriedades, variáveis, enfim todos os nomes devem estar em inglês, por que se um nerd chinês outro funcionário ver o seu código, conseguirá dar manutenção nele.
Estas são apenas algumas diretrizes de nomenclatura que devem ser aplicadas para qualquer linguagem. E estas regrinhas simples deixam um código mais legível e fácil de entender.
Sempre utilizem estas regras, quem for dar manutenção no seu código agradece. Até a próxima!