Projects in this course, will be
- developed using Eclipse (an Integrated Development Environment with features to support well-designed code)
- conform to standard Java 8
- hosted in a GIT repository within the course's Gitlab group
Thus, you will not "submit" projects as in other CompSci classes. Instead, you will be graded on what is in the master
branch of the repository by the end of the day on the due date. Your team is responsible for ensuring that all files are correctly push
ed to the repository.
Projects
- Game (individual)
- CellSociety (teams of 2-3)
- SLogo (teams of 4-5)
- VOOGASalad (teams of 8-10)
General Project Deliverables
In general, the code for each project must have
- Consistent coding conventions
It must look and read like it had a single author — think of a magazine: even though the articles have different authors, the style of the text formatting and illustrations is uniform - Good design practices
We will use a CheckStyle on all code in your source repository
- Documentation
Developing software is about more than just the code that makes the program run. We will use Javadoc to generate HTML documentation for each public package, class, function, and constant within your project.
To help manage this process, we suggest you download and import the following properties into Eclipse:
- Formatting rules for Eclipse to use when re-formatting your code
(Preferences -> Java -> Code Style -> Formatter
) - Clean up for Eclipse to use when cleaning up your code
(Preferences -> Java -> Code Style -> Clean Up
) - CheckStyle rules for Eclipse to use when re-formatting your code
(Preferences -> Checkstyle
)