Code Reading Checklist
β Code Reading Checklist
The Code Reading Framework is a set of five questions you can ask about any file in the robot project. By the end of this course, you should be able to answer all five questions for any file you open.
The Five Questions
- What does this file do?
- What subsystem or command does it belong to?
- What methods does it expose?
- What does it depend on?
- When does this code run?
File 1: IntakeSubsystem
Open
π Code Reading:
IntakeSubsystem.javaWhat does this file do?
What does this file do? _______________
What subsystem or command does it belong to?
What subsystem or command does it belong to? _______________
What methods does it expose?
What methods does it expose? _______________
What does it depend on?
What does it depend on? _______________
When does this code run?
When does this code run? _______________
File 2: AutoShootCommand
Open
π Code Reading:
AutoShootCommand.javaWhat does this file do?
What does this file do? _______________
What subsystem or command does it belong to?
What subsystem or command does it belong to? _______________
What methods does it expose?
What methods does it expose? _______________
What does it depend on?
What does it depend on? _______________
When does this code run?
When does this code run? _______________
File 3: RobotContainer
Open
π Code Reading:
RobotContainer.javaWhat does this file do?
What does this file do? _______________
What subsystem or command does it belong to?
What subsystem or command does it belong to? _______________
What methods does it expose?
What methods does it expose? _______________
What does it depend on?
What does it depend on? _______________
When does this code run?
When does this code run? _______________
Bonus: Pick Your Own File
Choose any file from the
π Code Reading:
(your choice).javaWhat does this file do?
What does this file do? _______________
What subsystem or command does it belong to?
What subsystem or command does it belong to? _______________
What methods does it expose?
What methods does it expose? _______________
What does it depend on?
What does it depend on? _______________
When does this code run?
When does this code run? _______________