CSC307 Lecture 08

Introduction to Software Engineering
Code Review
(202602)

Transcript

1. Dr. Javier Gonzalez-Sanchez javiergs@calpoly.edu www.javiergs.info o ffi ce: 14 -227 CSC 307 Introduction to Software Engineering Lecture 08. Code Review
2. Good Code vs Bad Code 2
3. Clean Your Code! • M a nuf a cturing vs. Cr a fting Softw a re • Code is me a nt for hum a n consumption, a nd it’s me a nt for computer consumption. • Cre a ting softw a re together but not scr a mbled 3
4. Not Everything that Can be … Should be … 4
5. Clean Code • 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. 5
6. Clean Code :: Readability (Easy to read to others) • Single Responsibility Principle (SRP) • Style a nd Comments • Do not Repe a t Yourselves (DRY) • Keep It Simple (KIS) • Dependency Injection (DI) • Error H a ndling 6
7. Single Responsibility • 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. • 7
8. 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. 8
9. Keep It Simple (KIS) • Aim for simplicity in your design a nd implement a tion. • Avoid unnecess a ry complexity or over-engineering. 9
10. Dependency Injection • An object’s dependencies (other objects it relies on) a re provided extern a lly r a ther th a n cre a ted intern a lly by the object itself. • Constructor injection: Dependencies a re p a ssed vi a the cl a ss constructor. • Setter injection: Dependencies a re provided through setter methods. • M a ke components more a ccessible to sw a p or extend without modifying the dependent cl a ss. 10
11. Readability 11
12. Agile in Action 12
13. Daily Scrum
16. Daily Scrum Module 01 Projects
17. J. P. O. L. O. S. Module Projects
18. Tip #1 18 Do not create a global variable Blackboard
19. Tip #2 19 If you are to receive a parameter Use the parent class instead of a child. Example: JFrame vs Main
20. Tip #3 20 EditProject<> vs NewProject<> It is 4 classes instead of 2 DRY :: Do not Repeat Yourselves
21. KIS 21 KIS - Keep it Simple Do we need this?
22. Daily Scrum Module 02 Data Objects
23. J. G. O. S. F. R. J. G. A. B. C. H. DRY :: Do not Repeat Yourselves
24. Ownership 24 Make sure your clients (dependents) are satisfied
25. Keep It Simple
26. Daily Scrum Module 03 Stories
27. N. G. L. G. J. G. Module Stories
28. Fix 28 BacklogStoryRenderer Review the Error about Incompatibility (class Story)
29. BacklogWindow.java 29 Clean your Code
30. NewStoryPanel.java 30 What about a method with more than 200 Lines?
31. Daily Scrum Module 04 Tasks
32. C. H. K. M. A. B. Module T a sks F. R.
33. CreateTaskPanel.java 33 What about a method with more than ~120 Lines?
34. CreateTaskPanel.java :: ~120 LOC 34 Can be done but Should be?
35. Blackboard as Attribute? 35
36. CreateTaskPanel.java 36 Blackboard as parameter?
37. MoveTasks.java 37 Do not use verbs as names for classes! Refactor MoveTasks to be Panel instead of Frame
38. Clean?
39. Daily Scrum Module 04 Main
40. I. P. D. X. Module M a in
41. Dependency Injections 41 Pass as a parameter Sprint or Stories or Project, so you do not need to pass a Full Blackboard for testing
42. Test Folder 42
43. Test Folder 43
44. Lab. Code Review
45. Lab 45 https://classroom.github.com/a/LXc5UHtr
46. Step 1 46 Fix your Code
47. Step 2 • Cre a te a Test Cl a ss for your very own Story (in the Test Folder) • No m a in methods inside of cl a sses th a t should not h a ve them, i.e., m a in methods for testing your p a rt goes on the test folder • Only one single m a in method in the j a v a source folder • The m a in method st a rt with “Show the Project P a ge” 47
48. Step 3. Who Calls Who? 48
49. Step 4 49 Draft a Class Diagram
50. Questions 50
51. CSC 307 Introduction to Software Engineering Javier Gonzalez-Sanchez, Ph.D. javiergs@calpoly.edu Winter 2026 Copyright. These slides can only be used as study material for the class CSC307 at Cal Poly. They cannot be distributed or used for another purpose.