Improving Code Quality

PHP Reboot meetup slides, presented on 24th June, 2017 at Ansh Systems Pvt. Ltd.

Transcript

1. Improving Code Quality Writing better code
2. About me • Name: Kapil Sharma • Technical Architect at Eastern Enterprise B.V. • Working in Web development since 12+ years, mainly in PHP. • Twitter: @kapilsharmainfo • Facebook: /kapilsharmainfo • LinkedIn: kapilsharmainfo • Web: kapilsharma.info • Slides: speakerdeck.com/ kapilsharma 2
3. About PHP Reboot • PHP developers community in Pune, India. • Conduct regular meet ups • meetup.com/phpreboot • phpreboot.com • Twitter: @phpreboot • Facebook: /PHReboot • Slack: phpreboot.signup.team 3 • Virtual team developing open source. • PHPreboot.com is open source website • github.com/phpreboot/website • Issues: waffle.io/phpreboot/ website • Contributions welcome. • Online webinars
4. Improving Code Quality Writing better code 4
5. PHPReboot.com Kapil Sharma What is code quality? • External 5 • Mainly functional -> Minimal bugs • Can be identified by QA and client. • Internal • Structure of code. • Can be identified in code review.
6. PHPReboot.com Kapil Sharma Defining good code 6 • Easy to understand. • Easy to maintain. • For humans (not computer). • Current and future requirements.
7. PHPReboot.com Kapil Sharma – Martin Fowler. Anyone can write code that computer can understand. Easy to understand Good developers write code that Humans can understand.
8. PHPReboot.com Kapil Sharma Easy to maintain 8 Easy to extend in future.
9. PHPReboot.com Kapil Sharma SOLID 9
10. PHPReboot.com Kapil Sharma MVC 10
11. PHPReboot.com Kapil Sharma Refactoring 11
12. PHPReboot.com Kapil Sharma First step 12
13. PHPReboot.com Kapil Sharma First step 13
14. PHPReboot.com Kapil Sharma 1. Follow style guide 14 PSR-2 Coding Style Guide Pear Coding Standards Zend Coding Standards JS Standard PEP PHP Code Sniffer PHP QA Tools gist https://gist.github.com/kapilsharma/db0f3754146899ec7948c826139cb97c
15. PHPReboot.com Kapil Sharma 2 - Create descriptive names • Method/function • Reader should not need to see the code. • Variable • Should tell what it stores. • Class • Must tell what exactly it do. • Namespace/package/library • Should have complete functionality. 15 Don't write whole story as name
16. PHPReboot.com Kapil Sharma 3 - Comment and Document • Doc-block for every class/method • For important functionality/complex code. 16 Refactoring: Extract method for comment.
17. PHPReboot.com Kapil Sharma 4 - DRY 17 Don’t Repeat Yourself
18. PHPReboot.com Kapil Sharma 5 - Split code into short, focused units • Method name suggest exactly what it do. • Method must fit in one screen. (<30 lines) • No much dependency. • Testable. • Simple. 18
19. PHPReboot.com Kapil Sharma 6 - KISS 19 Keep It Simple and Stupid
20. PHPReboot.com Kapil Sharma 7 - Use inbuilt functions and 3rd party lib. • Do not rediscover wheel. • Learn the basics and details of your language. • Keep watching top open source libraries. 20 Invest in yourself.
21. PHPReboot.com Kapil Sharma 8 - Don’t over-design. • Keep design focused on today’s need. • It doesn’t mean do not follow Open-close principle. • Design for future requirements, only if they do not complicate design. • Don’t make parameterised class, method, factory, deep inheritance etc to solve problem that do not exist. 21
22. PHPReboot.com Kapil Sharma 9 - Unit test • Learn about Unit test or Test Driven Development. 22 TDD Workshop https://github.com/kapilsharma/tddworkshop
23. PHPReboot.com Kapil Sharma 10 - Open source 23
24. PHPReboot.com Kapil Sharma Your decision 24
25. PHPReboot.com Kapil Sharma Your decision 25