Este documento resume uma apresentação sobre práticas de programação em .NET. A apresentação discute convenções de nomenclatura, princípios de design como SOLID e práticas de testes unitários. Exemplos de código demonstram cada tópico.

1. http://netponto.org 15ª Reunião Presencial - 23/10/2010 Práticas de programação em .NETRicardo Alves

2. Ricardo Alves Licenciado do Instituto Superior de Engenharia de Lisboa (ISEL) 4 anos de experiência profissional C#, WCF, ASP.NET, SQL, VS LightSwitch, Agilemethodologies

3. Agenda NamingConventions CodingPractices UnitTestsPractices

4. Também disponível em vídeo... Assista! http://www.vimeo.com/16498136

5. NamingConventions Código tem de reflectir a sua intenção Código claro e objectivo Meio caminho andado para documentação 

6. Naming Conventions NamingConventions da .Net Framework http://msdn.microsoft.com/en-us/library/ms229045.aspx Escolher nomes facilmente legíveis e claros Dar preferência a legibilidade sobre brevidade Não usar underscore, hífenes, ou qualquer caracter não alfanumérico Não usar abreviações como identificadores

7. Naming Conventions NamingConventions da .Net Framework http://msdn.microsoft.com/en-us/library/ms229045.aspx Só usar acrónimos que sejam bem conhecidos Regra do Bing Fazer uma pesquisa no Bing pelo acrónimo, se o acrónimo aparecer nos primeiros resultados então podemos usar Regra não se aplica a acrónimos do negócio Usar nomes comuns, como value ou item, em casos onde o identificador e o seu tipo não têm qualquer valor semântico Usado em parâmetros ou variáveis de iteração Não usar “Hungariannotation”

8. Naming Conventions NamingConventions da .Net Framework http://msdn.microsoft.com/en-us/library/ms229045.aspx Pascal Case A primeira letra é maiúscula e as restantes primeiras letras de cada palavra são maiúsculas ObjectContext, BackColor Camel Case A primeira letra é minúscula e as restantes primeiras letras de cada palavra são maiúsculas numberOfDays, isValid Uppercase Todas as letras são maiúsculas PI, ID

9. Naming Conventions Namespaces Pascal Case, não usar underscores Acrónimos de 3 ou mais letras devem usar Pascal Case Seguir padrão: <Nome da Empresa/Developer>.<Tecnologia> AppliedIS.TimeCard.BusinessRules IrritatedVowel.Controllers PeteBrown.DotNetTraining.InheritanceDemo PeteBrown.DotNetTraining.Xml

10. Naming Conventions Classes e estruturas Pascal Case, não usar underscores Não usar nomes começados por “I” a não ser que a próxima letra seja minúscula, para não confundir com interfaces Acrónimos de 3 ou mais letras devem usar Pascal Case Não devem usar o mesmo nome que o Namespace a que pertencem Widget InstanceManager XmlDocument MainForm DocumentForm HeaderControl

11. Naming Conventions Interfaces Usar as mesmas convenções que para as classes, mas o nome deve começar com um “I” e a próxima letra deve ser maiúscula IWidget IComponent

12. Demo #1: Validar NamingConventions através do FxCop demonstração

13. CodingPractices Princípios S.O.L.I.D.

14. CodingPractices SOLID Single ResponsibilityPrinciple Open/ClosedPrinciple LiskovSubstitutionPrinciple Interface SegregationPrinciple DependencyInversionPrinciple

15. CodingPractices Single ResponsibilityPrinciple

16. CodingPractices Single ResponsibilityPrinciple Uma classe não deve ter mais que uma razão para ser alterada

17. Demo #2: Single ResponsabilityPrinciple demonstração

18. CodingPractices Open/ClosedPrinciple

19. CodingPractices Open/ClosedPrinciple Deve ser possível alterar o comportamento duma classe sem a modificar

20. Demo #3: Open/ClosedPrinciple demonstração

21. CodingPractices LiskovSubstitutionPrinciple

22. CodingPractices LiskovSubstitutionPrinciple Classes derivadas devem ser substituíveis pelas suas classes base

23. Demo #4: LiskovSubstitutionPrinciple demonstração

24. CodingPractices Interface SegregationPrinciple

25. CodingPractices Interface SegregationPrinciple Classes não devem ser forçadas a implementar interfaces que não usam

26. Demo #5: Interface SegregationPrinciple demonstração

27. CodingPractices DependencyInversionPrinciple

28. CodingPractices DependencyInversionPrinciple Módulos não devem depender de outros Módulos, devem depender de abstracções Abstracções não devem depender dos detalhes, os detalhes é que devem depender das abstracções

29. Demo #6: DependencyInversionPrinciple demonstração

30. CodingPractices YAGNI Youain’tgonnaneedit DRY Don’trepeatyourself KISS Keepitsimple, stupid!

31. Unit Tests Practices Ser o mais simples possível Ser independentes entre si Devem testar uma unidade de código de cada vez Usar Mocks para simular componentes externos Não testar configurações Não devem fazer asserções desnecessárias

32. Unit Tests Practices Devem ter nomes claros e concisos Testar comportamentos e não métodos Testar apenas classes e métodos com visibilidade publica Criar testes para reproduzir bugs encontrados Assegurar que as excepções que são lançadas têm testes associados

33. Demo #6: UnitTestsPractices demonstração

34. Dúvidas?

35. Referências ThePrinciplesof OOD http://butunclebob.com/ArticleS.UncleBob.PrinciplesOfOod Design Guidelines for Developing Class Libraries http://msdn.microsoft.com/en-us/library/ms229042.aspx Framework Design Guidelines: Conventions, Idioms, and Patterns for Reusable .NET Libraries http://www.amazon.com/Framework-Design-Guidelines-Conventions-Libraries/dp/0321545613

36. Patrocinadores desta reunião

37. Obrigado! Ricardo Alves ricardoloboalves@gmail.com http://pt.linkedin.com/in/rmalves/ http://twitter.com/rmalves