Style Guidelines
These style guidelines must be followed on all assignment and lab submissions.
  • Use JavaDoc-compatible comments and always provide a docs folder with your submission:
    1. Styling guide
    2. Select Tools -> Generate JavaDoc…
    3. In the new window, set the output directory to a new directory called docs inside of your project folder.
    4. It should reside at the same level as the src and bin directories.
  • All submitted projects must be formatted as follows:
    1. First four letters of your last name.
    2. First three letters of your first name.
    3. Lab if this is a Lab, Assign if this is an assignment.
    4. XX signifying the number of the work.
    5. Example: MierGre_Lab_01
  • Use the default formatting your IDE provides or follow the Java Code Style.
  • Regardless of your choices in formatting, consistency is key.
  • The file that contains the main function must also contain a block comment like this at the very top:
    /**
    * Name: Gregory Mierzwinski
    * Date: January 18th, 2022
    * Description: …
    */
  • Use an auto-formatter if you have issues! See here for a guide on how to do it in IntelliJ.
  • Other files must also contain a description such as this at the top, but they can refer back to the main description if there is nothing to describe.
  • Submission exporting guidelines using a Zip file:
    1. Find your project folder through any file explorer, and compress it into a Zip.
    2. Keep the project name as the name of the Zip file.
    3. Send me the project to my email or Moodle (if it’s setup).
  • Submission exporting guidelines using Github:
    1. Install Git
    2. Click VCS/Version Control -> Create Git Repository..
    3. Select the folder that contains your project and click OK
    4. Click Git -> Github -> Share Project on Github
    5. Keep the project name as the name of the repository, keep it as private.
    6. Login to Github through the same window.
    7. After pressing Share a page will open up with the new repository.
    8. Download the zip of the repository from the Code dropdown.
    9. Send that zip to me by email or through Moodle.
      • If you make more changes, they will need to be pushed and the zip will change.