Sharing iP code quality feedback [for @codebreaker64] - Round 2 #6
Description
@codebreaker64 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/devin/Devin.java lines 36-43:
/**
* Get response for the GUI based on the command user has given.
*
* @param text inputted by user.
* @return a message based on command user has given.
* @throws DevinException if there is any error regarding user input.
* @throws IOException if there is any error regarding.
*/Example from src/main/java/devin/task/TaskList.java lines 32-39:
/**
* Add the new task into the task list.
*
* @param type type of task.
* @param input task detail.
* @param storage instance of Storage object.
* @throws DevinException if the todo description is empty.
*/Example from src/main/java/devin/task/TaskList.java lines 126-130:
/**
* Get the task list.
*
* @return TaskList
*/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 Messages
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.