Introduction to Design

Instructor: G. Rudolph, Summer 2006 Where should I be? Completed Mechanical Model with modifications Code should control the drive motors smoothly, light sensor detects boundaries, Ultrasonic sensor detects opponent Instructor: G. Rudolph, Summer 2006

Instructor: G. Rudolph, Summer 2006 Where should I be? “To Be Completed” (90%) Clean up code Comments in code Document Hardware Design Software Design Instructor: G. Rudolph, Summer 2006

Instructor: G. Rudolph, Summer 2006 Code Cleanup May have borrowed code and modified it Now we have to “make it ours” Show that we understand it Make sure everything is clear Want the code to match our design, whether or not the design is Documented, or In our heads Instructor: G. Rudolph, Summer 2006

Instructor: G. Rudolph, Summer 2006 Code Cleanup Make sure Object, Method, and variable names match our application Add/ Update Comments to match our application & style Compile and run periodically to make sure everything still works Remove any commented blocks of code Remove unused code Variables, methods, objects Instructor: G. Rudolph, Summer 2006

Instructor: G. Rudolph, Summer 2006 Comments Enough that you can remember what it is you were doing and thinking, if you had to maintain the code 6 months from now Comments for Class Each method Variables Lines of code as needed We will formalize this with Javadoc templates during Project 2 Instructor: G. Rudolph, Summer 2006

Instructor: G. Rudolph, Summer 2006 Hardware Design Assume the reader (me) has access to the Lego Set and the model books Describe what you added or changed Assemblies may be difficult to put into words without the aid of pictures Do your best Assume you can show them the parts you are using (optional) Hand drawings of pieces are acceptable Instructor: G. Rudolph, Summer 2006

Instructor: G. Rudolph, Summer 2006 Software Design 3 things to show 1. Objects 2. Their INTERESTING interrelationships 3. Their behaviors Instructor: G. Rudolph, Summer 2006

Instructor: G. Rudolph, Summer 2008 Where is the Design? Comments in code are closest to the code Pictures (or equivalent models) can Give “the big picture” Help communicate important details in ways that are difficult to see from code Instructor: G. Rudolph, Summer 2008