Mudanças entre as edições de "Boas Praticas Programacao"
| Linha 62: | Linha 62: | ||
| Parâmetro | | Parâmetro | ||
| Camel | | Camel | ||
| − | | <code> public class Convert {public static int ToInt32(string value); </code> | + | | <code> public class Convert {public static int ToInt32(string value); |
| − | + | } </code> | |
|} | |} | ||
| − | == Regras | + | == Criação de nomes == |
| + | |||
| + | O objetivo é normalizar a criação de nomes para variáveis, tipos, métodos... | ||
| + | |||
| + | === Regras gerais === | ||
* O projeto deve ser desenvolvido utilizando uma linguagem ubiquá. | * O projeto deve ser desenvolvido utilizando uma linguagem ubiquá. | ||
* Crie variáveis e métodos com nomes claros e não extensos. | * Crie variáveis e métodos com nomes claros e não extensos. | ||
| − | * Não utilize nomes genéricos. Exemplo: | + | * Não utilize nomes genéricos. Exemplo: <code> var teste; </code> |
* Não utilize acentos nos nomes. | * Não utilize acentos nos nomes. | ||
* Evite criar nomes que denotem negação. Exemplo: <code> bool usuarioNaoInscrito = true; if(!usuarioNaoInscrito){...} </code> | * Evite criar nomes que denotem negação. Exemplo: <code> bool usuarioNaoInscrito = true; if(!usuarioNaoInscrito){...} </code> | ||
=== Variáveis === | === Variáveis === | ||
| + | * Utilize camelCasing. | ||
| + | * Recomendado o uso de plural para variáveis que armazenem coleções. | ||
| + | * Recomendado a utilização de sufixos para booleanos. Exemplo : <code> bool emEdicao = false; </code> | ||
| − | === Métodos === | + | === Métodos, classes e interfaces === |
| + | * Utilize PascalCasing. | ||
| + | * Utilize o prefixo I para Interfaces. | ||
Edição das 17h01min de 4 de julho de 2016
Esta página serve com uma referência para a convenção de código e consulta para eventuais divergências entre modelos adotados na MSTECH.
Índice
Utilizando camelCasing e PascalCasing
Os projetos em .Net na MSTECH devem adotar o padrão de maiúsculas criados pela equipe da Microsoft.
camelCasing
O camelCasing consiste em tornar maiúscula todas as primeiras letras das palavras com exceção da primeira palavra.
EX: camelCasing, existeTitulo, idEscola ...
Utilize este padrão para variáveis e parâmetros. Quando a variável ou parâmetro possuir um acrônimo, utilizar as duas primeiras letras também minusculas.
PascalCasing
O PascalCasing consiste em tornar maiúscula toda primeira letra das palavras.
Ex: SalvarUsuario() e LoginExterno ...
Utilize este padrão para nome de métodos e propriedades de uma entidade.
Exemplos
| Identificador | Caso | Exemplo |
|---|---|---|
| Namespace | Pascal | namespace System.Security { ... }
|
| Tipo | Pascal | public calss StreamReader {...}
|
| Interface | Pascal | public interface IEnumerable {...}
|
| Método | Pascal | public class Object{ public virtual Length{ get; } }
|
| Propriedade | Pascal | public class Process {public event EventHandler Exited;}
|
| Campo | Pascal | public class MessageQueue {public static readonly TimeSpan InfiniteTimeout;} public struct UInt32 { public const Min = 0; }
|
| Valor do Enum | Pascal | public enum FileMode { Append,...}
|
| Parâmetro | Camel | public class Convert {public static int ToInt32(string value);
|
Criação de nomes
O objetivo é normalizar a criação de nomes para variáveis, tipos, métodos...
Regras gerais
- O projeto deve ser desenvolvido utilizando uma linguagem ubiquá.
- Crie variáveis e métodos com nomes claros e não extensos.
- Não utilize nomes genéricos. Exemplo:
var teste; - Não utilize acentos nos nomes.
- Evite criar nomes que denotem negação. Exemplo:
bool usuarioNaoInscrito = true; if(!usuarioNaoInscrito){...}
Variáveis
- Utilize camelCasing.
- Recomendado o uso de plural para variáveis que armazenem coleções.
- Recomendado a utilização de sufixos para booleanos. Exemplo :
bool emEdicao = false;
Métodos, classes e interfaces
- Utilize PascalCasing.
- Utilize o prefixo I para Interfaces.
