Course Programming Standards
Introduction to Computing
This document outlines the rules you should follow when you submit a programming assignment for grading. These rules will simplify the grader's job by standardizing the form and appearance of submissions. Any of these rules can be overridden by a particular assignment but, if the assignment doesn't say otherwise, follow each of them.
When you are asked to submit a set of files, you must submit them in two forms: electronically and hard copy.
Your print-out should fit on standard 8-1/2"x11" paper printed upright, with no line wrap.
If you would like to save paper, you may print your files "2-up".
Paper clips, folded corners, and nothing at all are not acceptable.
Electronic submissions will generally be due early on the morning of a class day. Unless told otherwise, you must submit your hardcopy by the beginning of our next class meeting. You may always deliver your print-out to the department office prior to class time.
Document each source file with a header block that includes the file's name, your name, the name of the file's original creator (if not you), and a modification history that lists the date of each change to the file and the change made.
Here's an example for a Python file:
## FILE: mileage.py ## AUTHOR: Eugene Wallingford ## DATE: 2014/07/21 ## COMMENT: Compute aggregate mileage from consecutive periods ## at different average paces ## ## MODIFIED: 2014/07/23 by Eugene Wallingford ## CHANGE: Added computation of total time ##
Your block need not look exactly like this, but it should contain the same information.
I do not require you to follow a lot of specific style rules, but I do ask you to follow several basic guidelines to improve the readability of your code.
As you will learn, indentation is essential to the Python interpreter.
If you have any questions about style, please ask.