Estudante

CODING STANDARD C#

ALEXANDRE ROSOT ANTUNES

CURITIBA
2013

1. INTRODUÇÃO
Este documento tem como objetivo criar uma aparência constante no código, de modo a facilitar seu leitura e compreensão, tornar fácil a manutenção e a reutilização do código, definir boas práticas de programação e elaborar uma padronização para o desenvolvimento em C#. Este documento tem como base o documento de mesmo nome elaborado pelo autor dotnetspider. Serão abordados os seguintes tópicos:



Convenções de nomenclatura;
Indentação e espaços;

2. Convenções de nomenclatura
Nota:
Os termos Pascal Casing e Camel Casing serão utilizados ao longo deste documento, para isto serão definidos brevemente nesta nota.
Pascal Casing – O primeiro caractere de todas as palavras deverá ser escrito em letra maiúscula, e todas as demais letras em minúsculo.
Exemplo: EngenhariaDeSoftware
Camel Casing – O primeiro caractere de todas as palavras, exceto da primeira palavra, deverá ser escrito em letra maiúscula, e todas as demais letras em minúsculo.
Exemplo: engenhariaDeSoftware

1. Os nomes de classes, métodos e variáveis devem ser escritos em português. 2. Deverá ser utilizado Pascal Casing para nomes de Classes. public class OlaMundo
{
...
}

3. Deverá ser utilizado Pascal Casing para nomes de Métodos. void DigaOi(string nome)
{
...
}

4. Deverá ser utilizado Camel Casing para variáveis e parâmetros de métodos. int contadorTotal = 0; void DigaOi(string nome)
{
string mensagemCompleta = "Olá " + nome;
...
}

5. Deverá ser utilizado prefixo “I” com Pascal Casing para interfaces
(Exemplo: IEntidade).
6. Use palavras significativas para nomear variáveis, não utilize abreviações. Certo: string endereco int salario

Errado: string sal string end

7. Não utilize caracteres isolados para representar nomes de variáveis, assim como i, n, s, procure utilizar nomes como indice, temp. Exceto em casos de variáveis temporárias utilizadas para dar