Boas práticas de programação em C# .NET

65 %
35 %
Information about Boas práticas de programação em C# .NET
Technology

Published on March 6, 2014

Author: fabianoberaldi

Source: slideshare.net

Description

Este documento descreve boas práticas de programação na plataforma .NET. Nós iremos ver:
- Padrões C# de nomenclatura;
- Dicas para boas práticas de programação;

Qual a finalidade:
- Escrever códigos de qualidade e fácil manutenção;

Em quais situações utilizaremos estes recursos:
- No desenvolvimento de qualquer programa .NET;

Fabiano Roman Beraldi Email: fabiano.beraldi@outlook.com

C# .NET Este documento descreve boas práticas de programação na plataforma .NET. Nós iremos ver: • Padrões C# de nomenclatura; • Dicas para boas práticas de programação; Qual a finalidade: • Escrever códigos de qualidade e fácil manutenção; Em quais situações utilizaremos estes recursos: • No desenvolvimento de qualquer programa .NET; Nota: apesar de existirem milhares de padrões, podemos dizer que nenhum deles está errado. O importante é escolher e seguir um padrão de desenvolvimento.

A linguagem de programação C# é case sensitive, ou seja, é sensível a letras maiúsculas e minúsculas. O compilador faz distinção entre letras com “CAIXA ALTA” e “caixa normal”. Portanto é importante nos basearmos nos padrões de nomenclatura – Naming Guide C# .Net. Os estilos de nomenclaturas que foram documento, baseiam-se nos Capitalization Styles da Microsoft. utilizados neste Nota: Os termos Pascal Casing e Camel Casing serão utilizados neste documento.

 Descrição: a primeira letra do identificador e primeira letra de cada palavra concatenada em maiúsculo. Use Pascal Case para: • Nome de classes e propriedades: public class Pessoa { public int Id {get; set;} public string Nome {get; set;} public string EnderecoResidencial {get; set;} } • Nome de métodos: public void RealizarVenda() { }

 Descrição: primeira letra minúscula e cada palavra concatenada em maiúscula. Use Camel Case para: • Nome de variáveis: int contagemTotal = 0; • Parâmetros dos métodos: private int SomarNumeros(int primeiroNumero, int segundoNumero) { int valorDaSoma = primeiroNumero + segundoNumero; return valorDaSoma; } • Use o prefixo I com Camel Case para interfaces. Ex: IEntidade;

• Dê um nome significativo para suas variáveis e evite abreviações: Correto: string nomeCompleto; DateTime dataDeNascimento; Incorreto: string nomComp; DateTime datNasc; • Não use caracteres simples para nomear suas variáveis, como por exemplo i, n, s, etc. Ao invés disto, use uma palavra como index, número, etc. Uma exceção, seria no uso de loops: for (i == 0; i < 10 ; i++) { }

• Não use underline (“_”) para variáveis locais; • Não utilize acentos ou espaços; • Variáveis booleanas deverão receber nomes que impliquem em verdadeiro ou falso: Ex.: bool existeTitulo; • Não criar nomes que podem conflitar com palavras reservadas do .NET Framework como where, string, etc. • A clareza nos nomes é essencial, isto facilitará muito uma manutenção futura no sistema; Nomenclatura para projetos do Visual Studio • Não criar itens dentro de uma Solution com o mesmo nome da Solution porque o VS não saberá quando estamos nos referindo ao rootnamespaces e poderá gerar erros;

Nomenclatura para projetos do Visual Studio (continuação) • Os nomes de projetos devem ser criados contendo o nome da Solução mais o nome do Projeto, exemplo: Nome da solução: - PontoDeVenda Nome dos projetos: - PontoDeVenda.DAL - PontoDeVenda.Repositorio - PontoDeVenda.Webform - PontoDeVenda.TestesUnitarios

 Descrição: os comentários poderão ser utilizados para identificação das funcionalidades dos métodos como também gerar documentação técnica de métodos para o sistema. • Sempre comentar os códigos gerados principalmente partes críticas ou complexas; • Os comentários devem ser no mesmo nível do código. Use o mesmo nível da endentação. Exemplo: Correto //Atribui à variável o valor da data atual DateTime dataAtual = DateTime.Now; Incorreto //Atribui à variável o valor da data atual DateTime dataAtual = DateTime.Now;

 Dicas: • Use TAB para indentação ao invés de espaços; • Use uma linha em branco para separar grupos lógicos. Exemplo: Correto string DigaOla (string nome) { DateTime horaAtual = DateTime.Now; string mensagem = String.Empty; string mensagemCompleta; mensagem = “Olá” + nome; mensagemCompleta = mensagem + “, a hora atual é “ + horaAtual.ToShortTimeString(); return mensagemCompleta; }

Dicas (continuação): Incorreto string DigaOla (string nome) { DateTime horaAtual = DateTime.Now; string mensagem = String.Empty; mensagem = “Olá” + nome; string mensagemCompleta; mensagemCompleta = mensagem + “, a hora atual é “ + horaAtual.ToShortTimeString(); return mensagemCompleta; } • Use #region para agrupar métodos ou declarações relacionados. Deste modo o código ficará mais organizado. • Mantenha as variáveis na parte superior;

Ao adicionar algum objeto para alguma interface de usuário (UI) que podem ser tanto web como desktop devemos observar as nomenclaturas das seguintes tabelas: • Windows Forms, WPF

• Windows Forms, WPF (continuação)

• WebPages, WebParts, WebForms

Referências http://www.devmedia.com.br/padroes-de-desenvolvimento-seguindo-boas-praticas-de-programacao/10751 http://devluciano.wordpress.com/2011/07/04/padres-de-nomenclaturas-naming-guide-c-net/ http://pt.wikipedia.org/wiki/Case_sensitive

#region presentations

Add a comment

Related presentations

Presentación que realice en el Evento Nacional de Gobierno Abierto, realizado los ...

In this presentation we will describe our experience developing with a highly dyna...

Presentation to the LITA Forum 7th November 2014 Albuquerque, NM

Un recorrido por los cambios que nos generará el wearabletech en el futuro

Um paralelo entre as novidades & mercado em Wearable Computing e Tecnologias Assis...

Microsoft finally joins the smartwatch and fitness tracker game by introducing the...

Related pages

Boas práticas em programação .Net - artigos TechNet ...

Reforçando o dito acima, alguns desenvolvedores preferem utilizar os tipos comuns em System para não ter de pensar em tipos de dados diferentes entre C# ...
Read more

Boas Práticas de Programação - Linha de Código - tudo ...

Boas Práticas de Programação. ... o C# e o Visual Basic .NET. ... de aplicações .NET. É palestrante em diversos eventos Microsoft no ...
Read more

Arquitetura e Boas Práticas em C# .NET

Arquitetura e Boas Práticas em C# .NET. Visual Studio Development > C#.
Read more

Boas Práticas com C# e .NET Framework - Revista .Net ...

Boas Práticas com C# e .NET ... obrigatoriamente em qualquer texto que fale sobre boas ... como boas práticas de programação auxilia o ...
Read more

Boas Práticas de Programação - Eu Faço ProgramasEu ...

... nos passou uma lista com 40 boas práticas de programação. ... C#: 4 espaços) Declare cada variável em uma linha para ... .Net em Vitória ...
Read more

Boas Práticas | Programando .NET

Posts sobre Boas Práticas escritos ... Artigos e Vídeos de Programação em Geral Menu Ir para ... Este post foi publicado em .NET, Boas Práticas, C#, ...
Read more

Visual C#

Boas práticas em C#. Na maioria das discussões que participei acerca do assunto “boas práticas ou qualidade em ... programação consolidaram em ...
Read more

Boas Práticas de Programação com ADO.NET

Boas Práticas de Programação ... de Arquitectura do .NET Conhecimentos de VB.NET ou C# Conhecimentos ... Boas práticas Erros em Stored ...
Read more

Boas práticas de programação em C# - Rafael França ...

Boas práticas de programação em C# ... Na plataforma .NET é possível fazer Upload de arquivos sem necessitar um componente específico por meio de uma ...
Read more