Style guide for Computer Programming assignments

2019-08-21

This document contains stylistic requirements for Java programs written in this course. All example programs adhere to these guidelines, so feel free to model your code style after those examples.


Include a header block comment at the top of the file with the following information.

Filename
Your name
Instructor's name
Course name
Date in format YYYY-MM-DD
Purpose: Short description of what the program does.
Acknowledgments (optional): Credit anyone else whose work you used in the program.

Example
            
/*
* Exercise_1_3.java
* 
* Johnny Hilltopper
* Mr. Gottsacker
* Computer Programming
* Marquette University High School
* 2019-08-10
* 
* Purpose: Display a piece of ASCII art.
* Acknowledgments: Art created by Cygnus Mineah. Link: http://ascii.co.uk/art/seatle
* 
*/
            
            

File location and naming conventions.

Solo exercises should be placed in the solo/ Google Drive folder. Each exercise should have its own Java file. Files should be named Exercise_X_Y.java, where X is the chapter number, and Y is the question number of the exercise. For example, Exercise_1_1.java is the file name of chapter 1's exercise 1.1.

Group projects should be placed in the group/ Google Drive folder. Only one person per group should submit code. Include all partners' names in the block comment at the top of the file. Java files should be named Project_X.java, where X is the chapter number. All group project Java files should have an accompanying README.txt file.


Credit any contributors.

Cite your sources if you used a resource other than the course textbook, lectures, or code examples. Provide a short description of the resource used and a link to it (if available).


Make complicated procedures easy to understand.

All calculations should be neat. Put spaces between numbers and operands. Document any unintuitive or complicated calculations with code comments above the procedure.