CSC305 Lecture 02

Individual Software Design and Development
Clean Coding
(202409)

Transcript

1. Dr. Javier Gonzalez-Sanchez javiergs@calpoly.edu www.javiergs.info o ffi ce: 14 -227 CSC 305 Individual Software Design and Development Lecture 02. Clean Coding
2. Critical Thinking
3. Manufacturing vs. Crafting
4. Example 4
5. Some Ideas. It is NOT a Complete List 5 MOVE EAT SHOW DETECT COLLISION MOVE/ HUNT SHOW SHOW/ CREATE SCORE HANDLING WINNER DETECTOR MOVE/ HUNT
6. Clean Coding SRP DRY KIS Errors Readability Comments
7. Clean Coding
8. Single Responsibility + Modularity • E a ch cl a ss or function should h a ve one, a nd only one, job. • Keep functions focused on a single t a sk. • Bre a k down your code into sm a ller, reus a ble modules or functions. • Ensure e a ch module or function h a s a cle a r, well-de f ined purpose. 8
9. Don't Repeat Yourself (DRY) • Avoid code duplic a tion by a bstr a cting common function a lity. • Use functions or cl a sses to enc a psul a te repe a ted jobs. 9
10. Keep It Simple (KIS) • Aim for simplicity in your design a nd implement a tion. • Avoid unnecess a ry complexity or over-engineering. 10
11. Error Handling • Implement robust error h a ndling a nd logging mech a nisms. • Use exceptions a ppropri a tely a nd a void silent f a ilures - keep the user informed! 11
12. Readability • Write e ff icient code but prioritize re a d a bility a nd m a int a in a bility. • Optimize perform a nce-critic a l sections only when necess a ry. 12
13. Commenting and Documentation • Write me a ningful comments th a t expl a in why something is done, not wh a t is done. • Keep comments up to d a te with code ch a nges. • Document public APIs a nd complex logic thoroughly. 13
14. Consistent Formatting • Follow a consistent code style a nd form a tting guidelines. https://google.github.io/styleguide/javaguide.html • Use indent a tion, whitesp a ce, a nd comments e ff ectively to enh a nce re a d a bility. 14
15. Meaningful Names • Use descriptive a nd un a mbiguous n a mes for v a ri a bles, functions, cl a sses, etc. • Avoid using misle a ding or cryptic n a mes. • Follow consistent n a ming conventions. 15
16. Refactoring • Regul a rly ref a ctor code to improve its structure a nd re a d a bility without ch a nging its function a lity. • Simplify complex code a nd elimin a te code smells. 16
17. Homework
18. Tic-Tac-Toe Show me your Java programming “best” skills in developing a Tic-Tac-Toe (text mode) Team of 2
19. Tic-Tac-Toe
20. Google Java Style Guide Read: https://google.github.io/styleguide/javaguide.html
21. Hint
22. Questions 22
23. Lab 02
24. Quiz (45 minutes - 15 questions) Let’s Test Your Java Programming
25. CSC 305 Individual Software Design and Development Javier Gonzalez-Sanchez, Ph.D. javiergs@calpoly.edu Fall 2024 Copyright. These slides can only be used as study material for the class CSC305 at Cal Poly. They cannot be distributed or used for another purpose.