PROG32758 Submission Standards

Standards for All Files in Submissions

All files in all submissions must include multi-line comments/documentation at the top of each source file in the following format:

For index.html files:

<!--
Name:  [your name here]
Assignment:  [the name/title of the submission]
Date:  [the due date of the submission]
[a blank line]
Description: [brief description your site/application]
Page: [brief description of the index page's purpose/role in the application]
Files: [a list (with summary descriptions) of other files that make up this application]
-->

For all other HTML files:

<!--
Name:  [your name here]
Assignment:  [the name/title of the submission]
Date:  [the due date of the submission]
[a blank line]
Description: [brief description this page's role/purpose in the site/application]
-->

For CSS files:

/*
 Name:  [your name here]
 Assignment:  [the name/title of the submission]
 Description: [a brief description of where this CSS file is used, e.g. which html pages?]
*/

Example: In this example, a submission consists of an application with index.html, call.html, and main.css. Each file should be identified as follows:

index.html:

<!--
Name:  Sydney Greenstreet
Assignment:  Assignment 3
Date:  August 3 2014

Description: This application allows emergency personnel to communicate with
the main dispatcher at the Hamilton SPCA.  The user can log in and view calls that
haven't been assigned, and they can accept unassigned calls and report on calls that
have been completed.
Description: This is the main login page for emergency personnel with the
Hamilton SPCA logo and contact information.  It also contains phone numbers in 
case the user is having technical problems with the web application.
Files: call.html - the database-driven calls page
       main.css - the main styles for this application
-->

call.html:

/* 
Name:  Sydney Greenstreet
Assignment:  Assignment 3
Date:  August 3 2014

Page Description: This is the page emergency personnel will see once they've
successfully logged in.  They will be able to see a list of unanswered calls,
select an unanswered call to attend to, and file reports for calls that they
have completed.
Files: index.html - the main login page for emergency personnel
       main.css - the main styles for this application
*/

main.css:

/*
Name:  Sydney Greenstreet
Assignment:  Assignment 3
Description: Used in all pages in the SPCA dispatch application.
*/

Additionally, all files included in submissions must meet industry standards and style conventions, as outlined in the Coding Standards for SYST10049 document. This document outlines things like proper indentation, spacing, naming conventions, brace styles, etc.

For Java Files

All submissions must include program identification documentation at the top of the source code file according to the following specifications:

Main class files - the file in your project that contains the main() method must include the following documentation in multi-line comment syntax (/* ... */):

Name:  [your name here]
Assignment:  [the name/title of the submission]
Program: [the name of the program you're enrolled in i.e. Computer Programmer or Programmer Analyst]

[a blank line]
[brief description of program]

Class files - classes, abstract classes, or interfaces that model objects or contain libraries of code must include documentation in multi-line comment syntax that identifies the programmer(s), the current source file and all other source files that are included in the project, and which class is the "main()" class, as shown below:
```
Name: [your name here]
      [programmer #2's name, if applicable]
      [programmer #3's name, if applicable]
File:  Employee.java
Other Files in this Project:
  FullTimeEmployee.java
  PartTimeEmployee.java
  CommissionEmployee.java
  EmpGui.java
Main class: Main.java
```

Internal Program Documentation

All code submitted must be properly documented with internal program documentation. (see Standards for Program Documentation from PROG10082 for more information.

Javadoc Comments

All OOP classes submitted must be properly documented using javadoc comments (/** ... */) with proper tags and attributes.

For more information, see Javadoc Comments for more information.

Additionally, all files included in submissions must meet industry standards and style conventions, as outlined in the Coding Standards for PROG24178 document. This document outlines things like proper indentation, spacing, naming conventions, brace styles, etc.

Standards for Electronic Submissions

In addition to the basic standards mentioned above, make sure you follow these instructions/standards also:

Electronic submission are usually uploaded to a web server or an LMS such as SLATE, or submitted via a memory key or portable hard drive to the professor. Therefore, your prof may have some specific naming conventions or other rules for the types of files you may upload/submit. These will be clearly stated in the assignment. If they are not clearly stated in the assignment, then the policy regarding submitted files is as follows:

All submissions must be contained within a single ZIP/RAR file.
Your ZIP/RAR file must be named login_assignmentName.ZIP or login_assignmentName.RAR where "login" is your actual Sheridan login name and "assignmentName" is the actual name of the assignment you are submitting (e.g. Lab1, Assignment2).
If you are asked to submit source code only, then your ZIP/RAR file should contain only the necessary .java source code files that make up your assignment.
Students in term 2 and higher are usually asked to submit the entire project (e.g. the entire NetBeans project). This means your ZIP/RAR file needs to include your entire project root directory.
You will sometimes also be asked to submit a text file or word processed document that contains all of your source code. This is for the Originality Checker in SLATE (it compares all of the submissions of all students at Sheridan over the past few years to make sure your code is original and not copied from another student (or that another student hasn't copied you!)) To create this file, simply open up any text editor or word processor (your professor will let you know which file formats they support) and paste all of your source code into it. This file is uploaded separately from your zip/rar file, not inside it.