Sharing iP code quality feedback [for @sh4nH] #3
Description
@sh4nH 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
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/TaskList.java lines 37-43:
/**
* Add a task (to-do,event or deadline) to the tasklist.
*
* @param taskName description of the task to be added.
* @param ui ui to print the confirmation messages after task is added
* to the list.
*/Example from src/main/java/duke/TaskList.java lines 82-86:
/**
* View the list of all tasks.
*
* @param ui ui to display the list of tasks to the user.
*/Example from src/main/java/duke/TaskList.java lines 91-96:
/**
* Mark a task as done/completed.
*
* @param num the index of task to be marked as done.
* @param ui ui to display confirmatory message.
*/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 👍
Aspect: Binary files in repo
No easy-to-detect 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 cs2103@comp.nus.edu.sg if you want to follow up on this post.