Sharing iP code quality feedback [for @hweinian] - Round 2 #5
Description
@hweinian 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/gravitas/storage/Storage.java lines 46-51:
/**
* Load the tasks from the storage to the task list.
*
* @return ArrayList of tasks
* @throws GravitasException If there is an error in loading the tasks
*/Example from src/main/java/gravitas/storage/Storage.java lines 71-76:
/**
* Save the tasks from the task list to the storage.
*
* @param tasklist TaskList object that contains the list of tasks
* @throws GravitasException If there is an error in saving the 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 351e343:
Add help command to improve user guidance
The app lacks a dedicated help command, which makes it difficult for users to understand how to use the GUI
To address this, a help command displays the possible feature that could be done by the app.
It is implemented in the GUI as users may want to know what command is available for them at any point in time
- body not wrapped at 72 characters: e.g.,
The app lacks a dedicated help command, which makes it difficult for users to understand how to use the GUI
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.