Mudanças entre as edições de "Boas Praticas Programacao"
De MSTECH wiki
(Criou página com ' 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. == Utilizando camelCasing e P...') |
|||
| Linha 32: | Linha 32: | ||
! Exemplo | ! Exemplo | ||
|- | |- | ||
| − | | | + | | Namespace |
| Pascal | | Pascal | ||
| − | | namespace System.Security { ... } | + | | <code> namespace System.Security { ... }</code> |
|- | |- | ||
| Tipo | | Tipo | ||
| Pascal | | Pascal | ||
| − | | public calss StreamReader {...} | + | | <code> public calss StreamReader {...}</code> |
|- | |- | ||
| Interface | | Interface | ||
| Pascal | | Pascal | ||
| − | | public interface IEnumerable {...} | + | | <code> public interface IEnumerable {...} </code> |
|- | |- | ||
| Método | | Método | ||
| Pascal | | Pascal | ||
| − | | public class Object{ | + | | <code> public class Object{ public virtual Length{ get; } } </code> |
| − | + | ||
| − | } | + | |
|- | |- | ||
| Propriedade | | Propriedade | ||
| Pascal | | Pascal | ||
| − | | public class Process { | + | | <code> public class Process {public event EventHandler Exited;}</code> |
| − | + | ||
| − | } | + | |
|- | |- | ||
| Campo | | Campo | ||
| Pascal | | Pascal | ||
| − | | public class MessageQueue { | + | | <code> public class MessageQueue {public static readonly TimeSpan InfiniteTimeout;} public struct UInt32 { public const Min = 0; } </code> |
| − | + | ||
| − | + | ||
| − | } | + | |
| − | public struct UInt32 { | + | |
| − | + | ||
| − | } | + | |
|- | |- | ||
| Valor do Enum | | Valor do Enum | ||
| Pascal | | Pascal | ||
| − | | public enum FileMode { Append,...} | + | | <code> public enum FileMode { Append,...}</code> |
|- | |- | ||
| Parâmetro | | Parâmetro | ||
| Camel | | Camel | ||
| − | | public class Convert { | + | | <code> public class Convert {public static int ToInt32(string value); </code> |
| − | + | ||
} | } | ||
|} | |} | ||
| + | |||
| + | |||
| + | == 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: <code> bool usuarioNaoInscrito = true; if(!usuarioNaoInscrito){...} </code> | ||
| + | |||
| + | === Variáveis === | ||
| + | |||
| + | |||
| + | === Métodos === | ||
Edição das 16h44min 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);
} |
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){...}
