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. Manufacturing vs. Crafting
3. Clean Coding
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 DI
7. Clean Coding SRP DRY KIS Errors Readability Comments DI
8. Single Responsability
9. 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. • 9
10. Tic Tac Toe 10 Main Player Game
11. Tic Tac Toe 11 Main Player GameEngine GameBoard
12. Tic Tac Toe 12 Driver Player public class Driver { public static void main(String[] arg) { Player player = new Player(); Game game = new Game(); do { player.move(); game.move(); } while (!game.isOver()); } } Game
13. Tic Tac Toe 13 public class Driver { public static void main(String[] arg) { Player player = new Player(); Game game = new Game(); game.ready(); do { player.move(); game.move(); } while (!game.isOver()); game.bye(); } }
14. 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. 14
15. Dependency Injection What about text-based vs. GUI?
16. Tic Tac Toe 16 Main Player Game View
17. Dependency Injection 17 public class Driver { public static void main(String[] arg) { View view = new View (); Player player = new Player(view); Game game = new Game(view); game.ready(); do { player.move(); game.move(); } while (!game.isOver()); game.bye(); } }
18. Dependency Injection 18 public class Driver { public static void main(String[] arg) { View view = new View (); Player player = new Player(view); Game game = new Game(view); game.ready(); do { player.move(); game.move(); } while (!game.isOver()); game.bye(); } } public class View { public void print(String s) { System.out.println(s); } } public class Game { View myView; public Game(View v) { myView = v; } public void ready() { myView.print (“Welcome!”); } // more code … }
19. Dependency Injection To be continue …
20. Homework
21. Tic-Tac-Toe Show me your Java programming “best” skills in developing a Tic-Tac-Toe (text mode) Team of 2
22. Tic-Tac-Toe
23. Google Java Style Guide Read: https://google.github.io/styleguide/javaguide.html
24. Hint
25. Questions 25
26. Lab 02
27. Quiz (45 minutes - 15 questions) Let’s Test Your Java Programming
28. 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.