Como em todas as linguagens, o C# não é excepção, exitem algumas covenções que devem de ser seguidas, quer na estrutura do código, como por exemplo a localização dos “{}” ou até mesmo dos espaços entre os vários campos. Estas convenções poder ser encontradas na documentação da Microsoft através de uma pequena pesquisa.
Neste post aproveito para partilhar as convenções mais utilizadas para nomear métodos, variáveis, propriedades ou até classes. Aqui deixo as convenções que eu gosto de usar nos meus projetos. A maioria são as próprias conveções da Microsoft, mas há uma ou outra que posso não seguir. De modo geral classes, métodos e propriedades devemos de utilizar PascalCase, ou seja, começar a primeira palavra com maiúsculas e capitalizar as restantes palavras. Nas variaveis dentro dos métodos sejam contantes ou não utilizo camelCase em que a primeira palavra fica toda em minúsculas e as restantes palavras com a primeira letra maiscula. as propriédades privadas, nas classes, também utilizamos o camelCase, mas com um “_” no inicio o que facilita muito identificar logo se estamos utilizar uma variável local do método ou uma variável global da classe. As interfaces e Templates também se usa o PascalCase, mas para não confundir com tipos de dados e classes coloco um “I” e “T” no inicio, respetivamente.
Elemento | Convenção |
---|---|
Classes | PascalCase |
Propriedades | PascalCase |
Métodos | PascalCase |
variáveis de classe | _camelCase |
constantes de classe | ALL_UPPER_CASE |
variáveis de método | camelCase |
constantes de método | camelcase |
Interfaces | IPascalCase |
Templates | TPascalCase |
Structs | PascalCase |
Enum | PascalCase |
Elementos Enum | PascalCase |