Sharing iP code quality feedback [for @weichang18]

[nus-se-bot]

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 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: Header Comments

Example from src/main/java/duke/Parser.java lines 5-10:

    /**
     * Return the integer x value when input "done x" command.
     *
     * @param input Input of user.
     * @return The index of the task to be marked done.
     */

Example from src/main/java/duke/Parser.java lines 15-20:

    /**
     * Return the integer x value when input "delete x" command.
     *
     * @param input Input of user.
     * @return The index of the task to be deleted.
     */

Example from src/main/java/duke/Parser.java lines 25-30:

    /**
     * Return the description of the to-do task when input "todo xxx" command.
     *
     * @param input Input of user.
     * @return The to-do task description.
     */

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)

possible problems in commit f78553e:

Inputting done or delete with an index more than task list cause error.

• Not in imperative mood (?)

Suggestion: Follow the given conventions for Git commit messages

ℹ️ The bot account @cs2103-bot 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.