@Rye-Catcher 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/pyke/Pyke.java
lines 86-86
:
boolean exitFlag = false;
Example from src/main/java/pyke/command/MarkCommand.java
lines 12-12
:
private boolean markType;
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/pyke/Pyke.java
lines 38-42
:
/**
* The method to initialize the ui component
* It will load the local file into taskList.
* @return the message to be sent after initialization
*/
Example from src/main/java/pyke/Pyke.java
lines 52-57
:
/**
* The runtime processing command component for GUI application
* For an input given, it will evaluate and run the command and return corresponding results
* @param input the user input received from GUI controller
* @return the corresponding output from running the input command
*/
Example from src/main/java/pyke/command/AddDeadlineCommand.java
lines 73-77
:
/**
* To know if this command will exit the program
*
* @return true if this method will exit the program
*/
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 ๐
โน๏ธ The bot account @nus-se-bot 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.