@waffledood 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
Example from src/main/java/duke/command/FindCommand.java
lines 35-35
:
boolean tasksMatchingSearchKey = false;
Example from src/main/java/duke/command/MarkCommand.java
lines 14-14
:
Example from src/main/java/duke/gui/Main.java
lines 21-21
:
private boolean repeatingReminders = true;
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/duke/command/Command.java
lines 30-36
:
/**
* A method that performs the logic associated with user-request command, using
* TaskList, Ui & Storage.
* @param taskList The TaskList containing current tasks.
* @param ui The Ui object interacting with the user.
* @param storage The Storage object for loading & saving of user's tasks.
*/
Example from src/main/java/duke/command/CommandType.java
lines 32-36
:
/**
* Initialize the CommandType Enum, by passing in the user input String.
* @param commandString String representing the user's input.
* @param regex The regex associated with the CommandType.
*/
Example from src/main/java/duke/command/CommandType.java
lines 42-47
:
/**
* Method to retrieve the CommandType Enum associated with the user's input.
* @param commandString User input String
* @return Enum representing the CommandType.
* @throws DukeException Error if the user input String is an unrecognized command.
*/
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 (Subject Only)
No easy-to-detect issues ๐
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 [email protected]
if you want to follow up on this post.