@Fidget-Spinner 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/duke/Storage.java
lines 23-28
:
/**
* Save tasks to file.
*
* @param tasks ArrayList of tasks.
* @throws ChatException if we cannot write to the file.
*/
Example from src/main/java/duke/Storage.java
lines 41-46
:
/**
* Load tasks from a file.
*
* @return ArrayList of tasks
* @throws ChatException if file cannot be read or loaded from.
*/
Example from src/main/java/duke/TaskList.java
lines 31-36
:
/**
* Return a task at a certain index in the list.
*
* @param idx Zero-based index in task list.
* @return The task at said index.
*/
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 6a3f91b
:
Fix DialogBox min height too small
This was causing text to shrink until nothing when there were too many messages.
- body not wrapped at 72 characters: e.g.,
This was causing text to shrink until nothing when there were too many messages.
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.