Reflection 2.2 - Elements of Good Code
[Due by the start of class on Monday, March 7]
But First!
If you have not already done so, please complete Reflection 2.1.
What is a Primer
According to Wikipedia:
A primer is a first textbook for teaching of reading, such as an alphabet book or basal reader. The word also is used more broadly to refer to any book that presents the most basic elements of any subject.
We want to create a document that would be a handout you could give students as a Good Code Primer.
It should include your initial thoughts about why "good coding style" should be addressed and some characteristics of good code. Note that these should be your thoughts, not merely copied ideas from someone else.
Your "Reflection"
Your good code document will likely include (not necessarily in the order or form shown below):
- Discussion of why you think good coding style is useful or important
- A set of things you think should should be addressed in thinking about good code
- An annotation for each of the good coding/style elements that explains/describes it it
This matters from two different perspectives.
- We can't decide on what is important to us if we don't actually reflect on what is important. Use the creation of this document as an opportunity to reflect on what was/is important to you when it comes to code readability.
- [Note, I didn't actually require code readability from you in the FOP course. Autolab told us that your code worked and I tended to let it slide. HOWEVER, we talked about good code as much as we could. Many of the code walkthrough activities focused on not only "working" code but GOOD working code.]
- This can be turned in to something that you use with your students if/when you start to teach. What messages do you want to convey to your students.
The idea for this activity is to bring your thoughts to the table and to be ready to produce a group document with your new small group partners.
Make sure that your give this some legitimate thought and that that you understand what you have written. Again, think about this as a document that you might share with your students about what good code is and why it is useful/important. You will want to prepare your document in a manner that makes it easily shareable with your group members.
Don't let your group members down. Bring good stuff to the meeting.
Submission
You are to submit a pdf version of your good code primer document via Blackboard.
Be sure to submit your work (in whatever state) by the deadline—late work can be shared with your group but will not be counted in the grading. Note that the system overwrites previous submissions, so sending a draft document in early and then submitting revisions (with the same title) is a good idea.
I will be looking for evidence of thought and effort put into the activity and (to a lesser extent) communication/writing. Indicators of thought and effort include how much information was included, that the information is in one's own words (rather than being copied from other sources), comprehensiveness of ideas (the reading material is addressed, though not everything needs to be included), and (perhaps) ideas you encountered elsewhere or thought of on you own.
As with previous reflections, this will only be evaluated as "meets expectations" (1) or 'does not meet expectation' (0).
In case of emergency and you cannot finish your work, please contact us ASAP.