Sharing iP code quality feedback [for @harin0826] - Round 2

[nus-se-script]

@harin0826 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/Duke.java lines 84-86:

    /**
     * Method that executes on start up.
     */

Example from src/main/java/duke/TaskList.java lines 83-89:

    /**
     * Method to merge parsed arguments into relevant string.
     * @param strings Parsed argument as array of strings.
     * @param from Index of first string to be merged.
     * @param to Index of the string that should not be merged (end index).
     * @return Merged string of arguments.
     */

Example from src/main/java/duke/TaskList.java lines 189-192:

    /**
     * Called by find method if searching for keyword.
     * @param keyWord Matching keyword to search for in 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 Message (Subject Only)

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.