Padrões de documentação e codificação de código fonte – asp.net/c#

Padrões de Documentação e Codificação de Código Fonte – ASP.net/C#

1. Introdução Este documento tem o objetivo de definir os padrões de Documentação e Codificação do Código Fonte. Buscando assim facilitar o entendimento do software por qualquer colaborador, com o mínimo de conhecimento em desenvolvimento.
2. Padrões de Desenvolvimento
1. Padrões de Estilo de Capitalização de Texto
1. Pascal Case
A primeira letra do identificador e a primeira letra de cada palavra concatenada subsequente são capitalizadas.
Ex.: IServiceProvider
2. Camel Case
A primeira letra do identificador é minúscula e a primeira letra de cada palavra concatenada subsequente é capitalizada.
Ex.: isValid, numberDaysWeek
3. Uppercase
Todas as letras do identificador são capitalizadas.
Ex.: CONSTANTE
2. Endentação de Código
Por padrão a tabulação é definida por 4 espaços.
Evitar linhas de código com mais de 80 caracteres.
Quebra de linhas:
• Quebrar após vírgula;
• Quebrar após um operador;
• Alinhar a nova linha no inicio da expressão no mesmo nível da linha anterior.
Ex.: chamarMetodo( param1, param2, param3, param4, param5, param6, param7); soma = a + b + c + d + e + f;
3. Comentários
Utilizar as três barras “///” para comentários de classes e métodos. O motivo é utilizar a funcionalidade do Visual Studio .NET de transformar comentários em documentação de código.
Entretanto, para comentários que não necessitam ser publicados, seguem algumas sugestões:
• Comentário com mais de uma linha:

/**
* linha um
* linha dois
**/

• Comentários de uma linha devem ser utilizados para identificação de início de um nível endentação ou loop dentro de um bloco. Ou ainda para explicação de declaração de variáveis.
// entra em um loop para fazer algo
While(true)
{ int dedos = 0; // variável utilizada para contar
}
• Comentários de Classes e Métodos
///
///Método retorna algo
///
///Descrição parâmetro 1.
///Descrição