CSI 115 Style Criteria Used for Evaluating Pseudocode, java programs and Class Diagrams

Assignments submitted for grading are evaluated to determine if the submitted work fulfills the
requirements of the assignment and to determine if the work meets the style guidelines used in the
course. This Style Guide below specifies the criteria used to evaluate assignments.

Naming Conventions

Identifier Naming Rule These naming rules apply

to all identifiers:
variable must begin with a lowercase letter. If a
 descriptive
variable contains more than one word, use
camelCase i.e. first word begins with
lowercase letters, the rest begin with  begin with a letter
uppercase letter. Example:
salePrice, amountDue, totalScore etc.  consist of only:
constant all letters must be uppercase. Use • letters,
underscore to separate words • digits,
Constant Real SALES_TAX = 0.06 • underscore may be
class  must begin with an uppercase letter used but not advisable
 cannot consist of all uppercase
 contain no embedded
spaces
object must begin with a lowercase letter
attribute must begin with a lowercase letter. If more
(data than one word, use camelCase style.
member)

method  must begin with a lowercase letter

 name must be followed by a set of
parentheses
 ex. printInfo( )

Pseudocode Criteria

Keywords Uppercase and lowercase is applied correctly

Keywords are used correctly (see list of valid keywords below)
Operators Operators are used correctly (see list of valid operators below)
Indentation 4 spaces are used as the level of indentation
All structures are indented appropriately
Whitespace Whitespace is used appropriately, in the form of spaces, tabs, and
newlines, to improve the readability of the pseudocode
– Separate method definitions with a blank line
 – Separate class definitions with a blank line
– Use a space before and after each operator
Examples:
age = 5 rather than age=5
age = age + 1 rather than age=age+1
Attributes Includes access modifiers (private or public)
Includes the data type
Follows naming conventions
Uses the correct order:
accessModifier dataType attributeName
Uses descriptive names
Methods Header:
Includes access modifiers (either private or public)
Includes the return type
Follows the naming conventions for method names
Includes the parentheses to indicate this is a method name rather
than an attribute name or object name
Includes parameters when appropriate
Follows naming conventions for mutator parameter names
Parameters are in the format: dataType identifierName
and are separated by commas
Body:
All statements are indented correctly
Control structures are used correctly
For a function the Return statement is present, along with the
required return value

Valid Keywords and Operators Used in CSI 117 Pseudocode

Classes and Modules and Class…End Class

Methods Module…End Module
Function…End Function
Return
Data Types, Constants, Declare
and Declarations Constant
Integer
Real
Character
String
Boolean
InputFile
Input and Output Input
Display
Open
Close
 Read
eof()
Calculations Set
Module, Method, or Call
Function Calls
Access Modifiers Public
Private
Protected
Control Structures If…Else…End If
Select…Case…Default…End Select
While…End While
For…End For
Do…While
Logical Operators NOT
AND
OR
Relational Operators <
>
<=
>=
==
!=

Class Diagram Criteria

Correct Set Up Diagram contains 3 rows and 1 column and it is sized to its contents
Class name appears in first row, attributes appear in second row, and
methods appear in third row
Class Name Follows naming conventions
Attributes Includes access modifiers (either "-" for private, "+" for public, or "#"
for protected)
Follows naming conventions
Includes the colon
Includes the correct data type
Uses the correct order:
accessModifier attributeName: dataType
Methods Includes access modifiers (either “-” for private or “+” for public)
Follows naming conventions
Includes parentheses to indicate this is a method name rather than a
variable name. Parentheses are empty if the method has no parameters.
Otherwise, a valid parameter list appears inside the parentheses, listing
parameter name, a colon, and the datatype. Multiple parameters are
separated by commas. Functions specify the return type immediately
after the right parenthesis, showing a colon followed by the return type.