CST 338 – Project 1 Code Review

Code Review – Jian

Variable names, are they meaningful and clear?

For the most part, yes the variables are clear. However, there are some variables that are defined in functions with the same name as instance variables. While this isn’t an issue, it would be more clear to change it. Otherwise, very good naming scheme overall.

Logic that could be more efficient

The prompt for this assignment was very strict in the sense that it provided all the logic already, therefore there is not much to improve, its already very efficient as it is.

One thing that could be done is migrating the for-loops to the newer syntax that doesn’t require defining an i variable.

Unused imports or warnings.

Nope, all the imports are used and there are no other warnings.

Clear formatting

Formatting is very good, everything is clearly spaced, lined up, and there are no stray curly brackets anywhere. It is very clear.

Are there comments?

Yes, each user defined function has the required Javadoc comments on it.

Do all the tests pass?

Yes, all of the tests pass flawlessly


Code Review – Noah

Variable names, are they meaningful and clear?

yes, variables are very clear, there are no conflicting variable names.

Logic that could be more efficient

Not much, everything seems as if it was coded by a seasoned java developer.

Unused imports or warnings.

Yes, the java.util.Arrays import is unsused.

Clear formatting

Formatting is very good, everything is clearly spaced, lined up. Additionally, there are comments that separate different sections of code beautifully.

Are there comments?

Yes, the Noah defined comments and very well documented comments that describe logic and other functions.

Do all the tests pass?

Yes, all of the tests passed successfully.


Discussion & Comments