CSC307 Lecture 08

Introduction to Software Engineering
Code Review
(202602)

Transcript

1. Dr. Javier Gonzalez-Sanchez javiergs@calpoly.edu www.javiergs.info office: 14 -227 CSC 307 Introduction to Software Engineering Lecture 08. Code Review
2. Good Code vs Bad Code 2
3. Clean Your Code! • Manufacturing vs. Crafting Software • Code is meant for human consumption, and it’s meant for computer consumption. • Creating software together but not scrambled 3
4. Not Everything that Can be … Should be … 4
5. Clean Code • Write efficient code but prioritize readability and maintainability. • Optimize performance-critical sections only when necessary. 5
6. Clean Code :: Readability (Easy to read to others) • Single Responsibility Principle (SRP) • Style and Comments • Do not Repeat Yourselves (DRY) • Keep It Simple (KIS) • Dependency Injection (DI) • Error Handling 6
7. Single Responsibility • Each class or function should have one, and only one, job. • Keep functions focused on a single task. • Break down your code into smaller, reusable modules or functions. • Ensure each module or function has a clear, well-defined purpose. • 7
8. Don't Repeat Yourself (DRY) • Avoid code duplication by abstracting common functionality. • Use functions or classes to encapsulate repeated jobs. 8
9. Keep It Simple (KIS) • Aim for simplicity in your design and implementation. • Avoid unnecessary complexity or over-engineering. 9
10. Dependency Injection • An object’s dependencies (other objects it relies on) are provided externally rather than created internally by the object itself. • Constructor injection: Dependencies are passed via the class constructor. • Setter injection: Dependencies are provided through setter methods. • Make components more accessible to swap or extend without modifying the dependent class. 10
11. Readability 11
12. Getting Started 12
13. 13 Agile in Action
14. Sprint Module 01 Projects
15. Our Sprint 15
16. Johnny Parini Owen Ledrick Owen Sam Module Projects
17. 17 Tip #1 Do not create a global variable Blackboard
18. 18 Tip #2 If you are to receive a parameter Use the parent class instead of a child. Example: JFrame vs Main
19. 19 DRY EditProject<> vs NewProject<> It is 4 classes instead of 2 DRY :: Do not Repeat Yourselves
20. 20 KIS Keep it Simple Do we need this?
21. Sprint Data Access Object
22. Jonathan Garcia Owen Sam Finley Room Jonathan Garcia Alexander Collin Howard DRY :: Do not Repeat Yourselves
23. 23 Ownership Make sure your clients are satisfied
24. Keep It Simple
25. Sprint Module 02 Stories
26. Nick Grant Luis Garcia Jonathan Garcia Module Stories
27. Fix 27 BacklogStoryRenderer Review the Error about Incompatibility (class Story)
28. BacklogWindow.java 28 Clean your Code
29. NewStoryPanel.java 29 What about a method with more than 200 Lines?
30. Missing Code 30 Luis?
31. Sprint Module 03 Tasks
32. Collin Howard Kevin M. Alexander B. Module Tasks Finley
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? 38
39. Sprint Module 04 Chart, Bar, Main
40. Isaac Pruett Daniel Xavier Module Main
41. Dependency Injections 41 Pass as a parameter Sprint, so you do not need to pass a Full Blackboard object for testing
42. Test Folder 42
43. Test Folder 43
44. Lab.
45. 45 Lab https://classroom.github.com/a/LXc5UHtr
46. Step 1 46 Fix your Code
47. Step 2 • Create a Test Class for your very own Story (in the Test Folder) • No main methods inside of classes that should not have them, i.e., main methods for testing your part goes on the test folder • Only one single main method in the java source folder • The main method start with “Show the Project Page” 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.