Downloaded 64 times
Uploaded byTheo Jungeblut
Clean Code III - Software Craftsmanship at SoCal Code Camp San Diego (07/27/2013)
The document covers the principles of clean code and software craftsmanship, emphasizing the importance of maintainability through readability, simplicity, and proper organization. It highlights various tools that aid in writing clean code, such as ReSharper and FxCop, along with coding conventions and best practices for naming and structuring code. The content is largely based on the works of Robert C. Martin and aims to guide developers in creating efficient, understandable, and maintainable software.
More Related Content
Similar to Clean Code III - Software Craftsmanship at SoCal Code Camp San Diego (07/27/2013)
![Coded Agents – with UiPath SDK + LangGraph [Virtual Hands-on Workshop]](https://cdn.slidesharecdn.com/ss_thumbnails/codedagentsdeck-251215155422-5497c599-thumbnail.jpg?width=640&height=640&fit=bounds)
Clean Code III - Software Craftsmanship at SoCal Code Camp San Diego (07/27/2013)
- 1. Clean Code III Software Craftsmanship SanDiego, July 27th, 2013 SolCal Code Camp
- 2. Theo Jungeblut • Engineeringmanager & lead by day at AppDynamics in San Francisco • Coder & software craftsman by night • Architects decoupled solutions tailored to business needs & crafts maintainable code to last • Worked in healthcare and factory automation, building mission critical applications, framework & platforms • Degree in Software Engineering and Network Communications • Enjoys cycling, running and eating theo@designitright.net www.designitright.net
- 3. Overview • Why CleanCode? • The Power of Simplicity • Tools - Your Best Friend • From Names to Classes • The "Must Read"-Books • Summary • Q&A
- 4. Does writing CleanCode make us more efficient?
- 6. What is CleanCode?
- 7. Clean Code ismaintainable Source code must be: • readable & well structured • extensible • testable
- 8.
- 9. The “Must Read”-Book(s)byRobert C Martin A Handbook of Agile Software Craftsmanship “Even bad code can function. But if code isn’t clean, it can bring a development organization to its knees.”
- 10. Code Maintainability * PrinciplesPatterns Containers Why? How? What? Extensibility Clean Code Tool reuse * from: Mark Seemann’s “Dependency Injection in .NET” presentation Bay.NET 05/2011
- 11. Keep it simple,stupid (KISS)
- 12. KISS-Principle – “KeepIt Simple Stupid” http://blogs.smarter.com/blogs/Lego%20Brick.jpg by Kelly Johnson
- 13. The Power ofSimplicity http://www.geekalerts.com/lego-iphone/ Graphic by Nathan Sawaya courtesy of brickartist.com Graphic by Nathan Sawaya courtesy of brickartist.com
- 14. Graphic by NathanSawaya courtesy of brickartist.com
- 15.
- 16. .NET Tools andtheir Impact Tool name Positive Impact Negative Impact Resharper compiling ++++, learning +++ VS responsiveness -- FxCop code quality ++ compiling time - StyleCop code consistency +++ compiling time - StyleCop plugin for Resharper compiling time +++ VS responsiveness -- Ghost Doc automated docs potentially worse doc Spell Checker fewer spelling errors ++ performance -- Code Contracts testability, quality ++ compiling time -- Pex & Moles automated test ++ compiling time --
- 17. Resharper Features: – Code Analysis –Quick Fixes – Code Templates – Code Generation – Code Cleanup – Many, many more… “The single most impacting development addition to Visual Studio” http://www.jetbrains.com/resharper/
- 18. FxCop / StaticCode Analysis Code Analysis: – Correctness – Library design – Internationalization and localization – Naming conventions – Performance – Security http://msdn.microsoft.com/en-us/library/3z0aeatx.aspx
- 19. Style Cop withR# Integration Code Consistency & Readability: – Automated check of C# coding standard – Enforceable at check-in with TFS check-in Policy – Full Integration in Resharper with Style Cop plugin: – Code Analysis – Quick Fixes – Code Cleanup
- 20. http://submain.com/products/ghostdoc.aspx • Save keystrokesand time • Simplify documenting your code • Benefit of the base class documentation Ghost Doc
- 21. Spell Checker http://visualstudiogallery.msdn.microsoft.com/7c8341f1-ebac-40c8-92c2-476db8d523ce/ • Spelllchicking for literals and comments in VS
- 22. http://msdn.microsoft.com/en-us/devlabs/dd491992 • Design-by-Contract programming •Improved testability • Static verification • API documentation integration with Sandcastle
- 23. • Pex automaticallygenerates test suites with high code coverage. • Moles allows to replace any .NET method with a delegate. Microsoft Pex & Moles http://research.microsoft.com/en-us/projects/pex/
- 24. Names Matter • MeaningfulNames • Intention Revealing Names • Use Pronounceable Names • Use Searchable Names • Avoid Encoding (Hungarian) • Don’t be cute • Pick One Word per Concept • Use Problem Domain Names * Chapter extract: Robert C. Martin –” Clean Code”, Parson Education, Inc. 2008
- 25. Functions • Small –Do One Thing • One Level of Abstraction • No or only few Arguments • Have No Side Effects • Prefer Exceptions to Returning Error Codes • Don’t Repeat Yourself * Chapter extract: Robert C. Martin –” Clean Code”, Parson Education, Inc. 2008
- 26. Comments • Comments donot Make Up for Bad Code • Explain Yourself in Code • Clarification • Warning of Consequences • ToDo Comments • Javadocs in Public APIs * Chapter extract: Robert C. Martin –” Clean Code”, Parson Education, Inc. 2008
- 27. Bad Comments • Mumblings •Redundant Comments • Misleading Comments • Journal Comments • Noise Comments • Don’t use a Comment When you Use a Method or a Variable • Commented-Out Code * Chapter extract: Robert C. Martin –” Clean Code”, Parson Education, Inc. 2008
- 28. The Purpose ofFormatting • Team Rules – Consistency is King • Vertical Openness Between Concepts • Vertical Distance • Horizontal Alignment • Indentation • Write Journey Style Code Resharper & StyleCop – “Code Cleanup” * Kind of Chapter extract: Robert C. Martin –” Clean Code”, Parson Education, Inc. 2008
- 29. Classes • Class Organization •Encapsulation • Classes Should be Small • The Single Responsibility Principle • Cohesion • Organize for Change • Insolating from Change * Kind of Chapter extract: Robert C. Martin –” Clean Code”, Parson Education, Inc. 2008
- 30. The “Must Read”-Book(s)byRobert C Martin A Handbook of Agile Software Craftsmanship “Even bad code can function. But if code isn’t clean, it can bring a development organization to its knees.”
- 31. The “Must Read”-Book(s)byKrzysztof Cwalina, Brad Abrams Framework Design Guidelines “teaches developers the best practices for designing reusable libraries for the Microsoft .NET Framework.”
- 32. Summary Clean Code Maintainabilityis achieved through: • Readability (Coding Guidelines) • Simplification and Specialization (KISS, SoC, SRP, OCP, ) • Decoupling (LSP, DIP, IHP, Contracts, LoD, CoP, IoC or SOA) • Avoiding Code Bloat (DRY, YAGNI) • Quality through Testability (all of them!)
- 33. Downloads, Feedback & Comments: Q& A Graphic by Nathan Sawaya courtesy of brickartist.com theo@designitright.net www.designitright.net www.speakerrate.com/theoj
- 34.
- 35. … more References Resharper http://www.jetbrains.com/resharper/ FxCop/ Code Analysis http://msdn.microsoft.com/en-us/library/bb429476(VS.80).aspx http://blogs.msdn.com/b/codeanalysis/ http://www.binarycoder.net/fxcop/index.html Code Contracts http://msdn.microsoft.com/en-us/devlabs/dd491992 http://research.microsoft.com/en-us/projects/contracts/ Fakes (Previous Moles & Pex) http://www.richonsoftware.com/post/2012/04/20/Comparing-Microsoft -Moles-in-Visual-Studio-2010-to-Microsoft-Fakes-in-Visual-Studio-11.aspx http://research.microsoft.com/en-us/projects/pex/ StyleCop http://stylecop.codeplex.com/ Ghostdoc http://submain.com/products/ghostdoc.aspx Spellchecker http://visualstudiogallery.msdn.microsoft.com/ 7c8341f1-ebac-40c8-92c2-476db8d523ce// Lego (trademarked in capitals as LEGO)
- 36.
- 37. … thanks foryou attention! And visit and support the www.sandiegodotnet.com Please fill out the feedback, and… www.speakerrate.com/theoj