Sharing iP code quality feedback [for @gn07] - Round 2 #4
Description
@gn07 We did an automated analysis of your code to detect potential areas to improve the code quality. We are sharing the results below, so that you can avoid similar problems in your tP code (which will be graded more strictly for code quality).
IMPORTANT: Note that the script looked for just a few easy-to-detect problems only, and at-most three example are given i.e., there can be other areas/places to improve.
Aspect: Tab Usage
No easy-to-detect issues 👍
Aspect: Naming boolean variables/methods
No easy-to-detect issues 👍
Aspect: Brace Style
Example from src/main/java/grass/Storage.java lines 64-65:
}
catch (FileNotFoundException e) {Example from src/main/java/grass/Storage.java lines 92-93:
}
catch (IOException e) {Example from src/main/java/grass/Grass.java lines 49-50:
}
else {Suggestion: As specified by the coding standard, use egyptian style braces.
Aspect: Package Name Style
No easy-to-detect issues 👍
Aspect: Class Name Style
No easy-to-detect issues 👍
Aspect: Dead Code
Example from src/main/java/grass/Grass.java lines 61-61:
// public static void main(String[] args) {Example from src/main/java/grass/Grass.java lines 62-62:
// new Grass("./data/grass.txt").run();Example from src/main/java/grass/Grass.java lines 63-63:
// }Suggestion: Remove dead code from the codebase.
Aspect: Method Length
No easy-to-detect issues 👍
Aspect: Class size
No easy-to-detect issues 👍
Aspect: Header Comments
Example from src/main/java/grass/TaskList.java lines 23-27:
/**
* <p>add task to task list</p>
* @param task task object to be added to task list
* @since 1.0
*/Example from src/main/java/grass/TaskList.java lines 32-37:
/**
* <p>gest task in task list by index</p>
* @param index list index of task object to retrieve
* @return task object at index
* @since 1.0
*/Example from src/main/java/grass/TaskList.java lines 42-46:
/**
* <p>delete task from task list</p>
* @param index list index of task object to be deleted from task list
* @since 1.0
*/Suggestion: Ensure method/class header comments follow the format specified in the coding standard, in particular, the phrasing of the overview statement.
Aspect: Recent Git Commit Messages
possible problems in commit 96b5b6f:
A-CodeQuality
Improve quality of code and comments
There were some improvements to be made on the quality of code and comments in the repo.
Removes unreachable lines, unused legacy code and ensure comments are updated to recent changes.
Improve code readability and understandability.
- body not wrapped at 72 characters: e.g.,
There were some improvements to be made on the quality of code and comments in the repo.
possible problems in commit 4407953:
A-Assertions
Add assert statements to code
Some methods lack detailed checks for input values where assumptions on the input values are made.
Add assert statements to the methods.
This ensures application robustness by removing all assumptions in the code.
- body not wrapped at 72 characters: e.g.,
Some methods lack detailed checks for input values where assumptions on the input values are made.
Suggestion: Follow the given conventions for Git commit messages for future commits (do not modify past commit messages as doing so will change the commit timestamp that we used to detect your commit timings).
Aspect: Binary files in repo
No easy-to-detect issues 👍
❗ You are not required to (but you are welcome to) fix the above problems in your iP, unless you have been separately asked to resubmit the iP due to code quality issues.
ℹ️ The bot account used to post this issue is un-manned. Do not reply to this post (as those replies will not be read). Instead, contact cs2103@comp.nus.edu.sg if you want to follow up on this post.