Download to read offline
Uploaded byDennis Doomen
Practical tips for keeping your C# code base clean
As soon as a codebase grows to a certain point, almost every team struggles to keep that codebase under control. Coding conventions are no longer followed, code reviews become superficial, refactoring doesn't happen as often as it should, and developers lose sight of the original architecture. Fortunately our toolbox contains quite some tools to help you with this, and next to that there are plenty of practices and learnings to help structure your code in more functional manner.
More Related Content
Similar to Practical tips for keeping your C# code base clean
More from Dennis Doomen
Practical tips for keeping your C# code base clean
- 1. 40 practical tipsfor keeping your C# code base healthy Dennis Doomen @ddoomen | Principal Consultant | Microsoft MVP
- 2. About Me • CodingArchitect • .NET/C# • Bit of TS/JS/React/Vue • 29 years of “pro” experience • Author of FluentAssertions, Pathy, PackageGuard, Reflectify, .NET Library Starter Kit • www.dennisdoomen.com • BlueSky, Twitter, Mastodon, LinkedIn
- 3. Establish clean sourcecontrol guidelines
- 4. Establish (HTTP) exceptionand logging guidelines
- 5. Merge microservices thatdon't need independent scaling µService µService µService µService µService µService µService µService µService µService µService µService µService µService µService µService Modular Monolith µService µService µService µService Service Service Service Service Service Service
- 6. Align projects withthe deployment or reusability scope
- 7. Make the folderstructure explain the architecture
- 8. Keep concrete classesinternal by only exposing an interface
- 9. Use .editorconfig andPrettier to automatically format code
- 10. Use .NET analyzersand ESLint to get early code quality feedback
- 11. Use JetBrain’s CleanupProfiles for auto clean-up
- 12. Use directory.build.props and.editorconfigs to gradually enforce standards
- 13. Document the purposeof code, not how it does that
- 14. Organize code byfunctionality
- 15. Clarify code reviewcomment intent https://github.com/erikthedeveloper/code-review-emoji-guide
- 16. Consider Central PackageManagement Directory.packages.props MyProject.csproj y
- 17. Name and grouptests functionally
- 18. Use a well-knownbranching strategy
- 19. Split refactoring commitsfrom the rest
- 20. Use fixup commitsand interactive rebases
- 21. Reduce dependencies onunstable packages Main Package Application More stable package Contract Contract Source-only package Auxiliary Package Optional Dependency Dependency Package
- 22. Refactor using theRule of Three
- 23.
- 24. Use PolySharp touse newer C# features
- 25. Shared Module Module 1 Deduplicatecomplicated reusable code Complicated logic Module 2 Complicated logic Module 3 Complicated logic Module 1 Complicated logic Module 2 Module 3 Shared Module
- 26. Duplicate and simplify SharedModule Module 1 Simplified logic Module 2 Simplified logic Module 3 Simplified logic Module 1 Overly generic code Module 2 Module 3 Shared Module
- 27. Split shared projectsto reduce dependencies Shared Project Project 1 Project 2 Project 3 Project 1 Project 2 Project 3 Shared Project Shared Project Shared Project
- 28. Replace lots ofdependencies with a single reversed interface MyControll er ISomeRepository IExternalService IOtherModule Specific interface Adapter ISomeRepository IExternalService IOtherModule MyControll er
- 29. Get rid ofseparate validators and query/handlers patterns Finance Controller Some Request Handler Request validator IValidate<RequestValidator> IHandle<SomeRequestQuery>
- 30. Don’t forget theOO principles
- 31. Replace List<T> orDictionary<T> with a custom collection class Order OrderLine List< OrderLine > Order OrderLine OrderLineCollection
- 32. Don't introduce interfacesif you don't need them
- 33. Move container registrationsinto the functional folder
- 34.
- 35. Replace single-method interfaceswith delegates
- 36. Ensure every PRmakes the code a little bit better
- 37. Use // REFACTORand // SMELL comments https://www.infoq.com/articles/natural-course-refactoring/
- 38. Keep your licensesin check
- 39. Learn to useAI assistants and agents
- 40. Spell check yourcode
- 41. Replace Bicep &Terraform with Pulumi
- 42. Switch to GitHuband Dependabot or adopt Renovate
- 43. Use Nuke toevolve your build script over time
- 44.
- 45. Find me at bluesky:@ddoomen.bsky.social mastodon: @ddoomen.mastodon.social twitter: ddoomen email: dennis.doomen@avivasolutions.nl