Sharing iP code quality feedback [for @andong0909]

[soc-se-bot-red]

@andong0909 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

Example from src/main/java/woof/task/TaskList.java lines 96-96:

        boolean found = false;

Suggestion: Follow the given naming convention for boolean variables/methods (e.g., use a boolean-sounding prefix).You may ignore the above if you think the name already follows the convention (the script can report false positives in some cases)

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/woof/parser/Parser.java lines 133-139:

    /**
     * Parse the index for marking.
     *
     * @param index Second part of the CLI input.
     * @return A corresponding command for marking a task as done.
     * @throws Exception Illegal inputs such as non-integers.
     */

Example from src/main/java/woof/parser/Parser.java lines 145-151:

    /**
     * Parse the index for unmarking.
     *
     * @param index Second part of the CLI input.
     * @return A corresponding command for unmarking a task as done.
     * @throws Exception Illegal inputs such as non-integers.
     */

Example from src/main/java/woof/parser/Parser.java lines 157-163:

    /**
     * Parse the index for deleting.
     *
     * @param index Second part of the CLI input.
     * @return A corresponding command for deleting a task.
     * @throws Exception Illegal inputs such as non-integers.
     */

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 👍

---

ℹ️ 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.