@Darkarche3 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
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/area/Storage.java
lines 25-31
:
/**
* The Storage class manages files operations for storing and retrieving
* task data.
* It handles the interaction with the data files where tasks are located.
*
* @param tasks List of tasks
*/
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 1e5f67c
:
Update Javadocs
Updated javadocs so that all methods and classes had their respective javadocs comments.
- body not wrapped at 72 characters: e.g.,
Updated javadocs so that all methods and classes had their respective javadocs comments.
possible problems in commit 524ea4c
:
Update Parser.java
Changed parsePriority method to return error message based on incorrect input
Update parsePriority method
- body not wrapped at 72 characters: e.g.,
Changed parsePriority method to return error message based on incorrect input
possible problems in commit ec85b9b
:
Update Readme.md
Readme is incomplete.
Updating Readme allows for user to understand how to use the chatbot.
Update Readme by adding features of chatbot such as the commands.
This is to make it easy and direct for users to understand what commands the chatbot can follow.
- body not wrapped at 72 characters: e.g.,
This is to make it easy and direct for users to understand what commands the chatbot can follow.
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 [email protected]
if you want to follow up on this post.