Dicas De Desenvolvimento - C#

Treinamento

Microsoft .Net Fernando Datorre

.Net na Prática

Anexo 1 2

Anexo 1 Dicas de desenvolvimento Para facilitar o entendimento e o desenvolvimento, segue algumas dicas de programação que podem ser úteis no estudo ou no próprio desenvolvimento de códigos em tecnologia .Net.

Convenções de nomenclatura Pascal Case (P) Primeira letra de cada palavra é capitalizada. Não há espaços ou sublinhados entre palavras. Por exemplo, DocumentoPrincipal. Camel Case (c) Primeira letra de cada palavra, exceto a primeira palavra, é capitalizada. Não há espaços ou sublinhados entre palavras. Por exemplo, documentoPrincipal Sublinhado (Underscore) A utilização legítima de sublinhados é para campos de prefixo de classe. Por exemplo, _emEstoque . Esta tabela é baseada no material "C# Coding Standards for .NET". Identificador

Público Protegido Interno Privado Nota (Public) (Protected) (Internal) (Private)

Arquivo do Projeto (Project File)

P

Corresponde ao Assembly e ao Namespace

Arquivo de código fonte (Source File)

P

Correspondem as classes do projeto

Outros arquivos

P

Aplique onde necessário

Namespace

P

Classe ou Struct (Class)

P

P

P

P

Interface

P

P

P

P

Têm como prefixo maiúsculo o caractere “I”

Classe Genérica (Generic Class)

P

P

P

P

Use o prefixo T para os identificadores

Métodos (Method)

P

P

P

P

Use o Verbo ou Verbo-Objeto

Propriedade (Property)

P

P

P

P

Não use os prefixos Get ou Set

_c

Use somente para campos provados (private)

Campo (Field)

Parte integrante do material: “.Net na Prática” de Fernando Datorre

Anexo 1 3 Cosntante (Constant )

P

P

P

Campo Estático (Static Field)

_c _c

Use somente para campos provados (private) Sempre use Pascal Case

Enumerador (Enum)

P

P

P

P

Delegate

P

P

P

P

Evento (Event)

P

P

P

P

Variável (Variable)

c

Parâmetro (Parameter)

c

Abreviações Abreviações não devem ser usadas. Exemplos de abreviações: "comp" para "compute" ou "computer", "num" para "number" ou "win" para "window". Acrônimos só devem ser usados se o seu significado for entendido naturalmente. Um bom guia para descobrir os significados é utilizar o comando "Define: sigla" no Google. Ele mostrará o significado correto dos termos. Quando em dúvida, consultar o resto da equipe do e obter consenso. Exemplos de abreviações aceitas "radar", "Dicom", "Adt", "Ris". Duas letras acrônimos devem possuir a mesma sentença, seja ela maiúscula ou minúscula. Exemplo: "System.IO", "Dashboard.UI", "ioStream", "uiButton". Exceções: ID, no sentido de Identificador, é uma palavra, não uma abreviatura e, por conseguinte, não deveria seguir essa regra sempre deverão estar representado como, "id" ou, "ID". Acrônimos de 3 letras ou mais devem usar Pascal ou camel case, conforme adequado. Exemplos: "Dicom", "Adt", "ris", "Xml" , “Cpf” Métodos ou propriedades que retornam um valor booleano devem ser nomeadas para que seu nome indique uma afirmação positiva. Exemplos: "IsReady", "ContainsChildren", "BatchJobCompleted"

Formatação de código 1 - Chaves para blocos de código devem estar sempre em uma linha.

Parte integrante do material: “.Net na Prática” de Fernando Datorre

Anexo 1 4

2 – Blocos de código de apenas uma linha, as chaves podem estar numa única linha.

3 – Use o caractere de tabulação em vez de espaços. Isso permite que membros de equipe que têm diferentes preferências da quantidade de espaço em branco possam configurar seu editor da sua maneira pessoal, ou seja, você não força ninguém a usar uma quantidade fixa de espaços. 4 - Declarações case devem ser recuadas da instrução switch a que elas pertencem.

5 – Use a documentação de código para facilitar a distribuição e entendimento dos códigos desenvolvidos.

6 – Para documentação interna usem a barra dupla sempre que possível (se preferir, use /* para abrir um bloco de comentário e */ para fechá-lo). 7 – Deve haver um espaço após uma vírgula em uma lista de argumentos passados para um método.

8 – Deve haver um espaço em torno de operadores

9 – Não usem espaço dentro de Colchetes

Parte integrante do material: “.Net na Prática” de Fernando Datorre

Anexo 1 5 10- Use Namespaces para referenciar recursos fora do seu contexto.

O próprio editor do Microsoft Visual Studio ajuda na formatação do código, deixando-o padrão. Caso queira alterar os padrões, acesse o menu Tools e em seguida a opção Options. Essas foram algumas dicas para o estudo e o desenvolvimento de códigos em tecnologia .Net, nos exemplos utilizamos a linguagem C#, boa sorte e bons estudos.

Parte integrante do material: “.Net na Prática” de Fernando Datorre