STYLE SHEET
CS 202: Programming Systems
Description of Design and Tools
used:
•
With each program you must provide a written discussion of the tools used, and
the major design consideration encountered when solving the specified problem
(1 page minimum for each). Both must
be typed.
• This must be written in English using
complete sentences. Each major design issue should be described; pseudo code
and drawings may be used to describe your design. In the design considerations,
discuss what the main design considerations are, why they are the main design
considerations, how you solved them, and why you solved the way you did. Think in terms of analyzing your solution!
•
Answer the following questions in your design writeup:
1)
How well did the data structure perform for the assigned application?
2)
Would a different data structure work better? Which one and why...
3)
What was efficient about your design and use of the data structure?
4)
What was not efficient?
5)
What would you do differently if you had more time?
• Please note that this should not
look like C or C++ code; words such as "cin", "cout",
"++", "--" should not be part of your description. Any
documents submitted which look identical to C or C++ code will not be accepted.
• The description of the tools used should
discuss what the tools were, their purpose, how you used them, what features
and benefits they provide, and what draw backs they have.
• Please paper clip this part of the
assignment to the "Program Cover Sheet" before you turn in your program. Please don’t use
staples!
LISTING
OF SOURCE CODE (as printed on the line printer)
Requirements
for internal documentation in the form of comments are listed below.
1. A heading explaining what the program does
and listing the name of the program author, date, class number and program
number. A heading must be supplied
indicating the purpose of the entire program; in addition, each separate
function should have a heading describing it purpose and arguments.
2. Each file should also have a heading,
explaining the purpose of that module and the listing the filename (this
is important!).
3. A comment following each variable definition
telling what it is used for.
4. Comments to explain any program action whose
purpose is not obvious to anyone who reads the code.
5. Use mnemonic names for identifiers that relate to
their purpose.
The following are source code format requirements.
1. A consistent pattern of indentation. See the attached C++ style requirement for
examples.
2. White space (blank lines) to separate
functions.
3. For each function, explicitly list the input
data and the output that will result from that function. Make sure to include a
header comment for each function; this should explain the purpose of the
function as well as describe the INPUT and OUTPUT arguments.
This means that there must be a header
for each function definition. Even for each member function!
4. INSTRUCTIONS
TO EMAIL PROGRAMS: In the subject field of your email, indicate two things:
your last name and the assignment number followed by the word “submission”
(this way I will know that the program is being turned. When you mail the program, using the
following command typed at the UNIX prompt. Do Not Use Pine to
accomplish this!
Programs
must be emailed using the following syntax:
type:
/bin/sh
at
the prompt type: shar –T file1.c file1.h file2.c >prog1
next,
type control-d
To
email this archive, type the following. The double quotes are essential!
mailx
-s “My Name - 202 Prog #1 Submission ” karlaf@cs.pdx.edu <prog1
This
represents how you might submit the first program that has the filenames:
file1.c and file2.c
5. REMINDERS:
Every program must have a comment at the beginning with your first and last
name, the class (CS202), and the assignment number. This is essential!