Sharing iP code quality feedback [for @JumpyJay] #4
Description
@JumpyJay We did an automated analysis of your code to detect potential areas to improve the code quality. We are sharing the results below, to help you improve the iP code further.
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
Example from src/main/java/milo/command/AddCommand.java lines 23-23:
private boolean dateError = false;Suggestion: Follow the given naming convention for boolean variables/methods (e.g., use a boolean-sounding prefix).You may ignore the above if you think the name already follows the convention (the script can report false positives in some cases)
Aspect: Brace Style
No easy-to-detect issues 👍
Aspect: Package Name Style
No easy-to-detect issues 👍
Aspect: Class Name Style
No easy-to-detect issues 👍
Aspect: Dead Code
No easy-to-detect issues 👍
Aspect: Method Length
No easy-to-detect issues 👍
Aspect: Class size
No easy-to-detect issues 👍
Aspect: Header Comments
Example from src/main/java/milo/MainWindow.java lines 59-61:
/**
* Greet users
*/Example from src/main/java/milo/MainWindow.java lines 88-90:
/**
* Method that exits the program with a delay
*/Example from src/main/java/milo/Milo.java lines 26-28:
/**
* Initialise Milo bot and its Ui, Storage, TaskList field
*/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 Message
possible problems in commit 5224ed4:
Improve code quality.
There were many unneccesary and unoptimised code present in the
last commit due to the drastic change of abstracting command in
the readInput method of the Parser class.
Implemented more inline variable, removed unused imports, removed
the unused fields in Ui class and minimise scope of variables,
specifically in the Ui class.
This is to improve the code quality, according to W5.4
- Subject line should not end with a period
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 👍
ℹ️ 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.