Sharing iP code quality feedback [for @e0543517]

[nus-se-bot]

@e0543517 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/Duke.java lines 17-20:

    /**
     * Create a chatterbot.
     * @param filePath The file's storage path.
     */

Example from src/main/java/duke/List.java lines 104-109:

    /**
     * Find a set of tasks that matches the description.
     *
     * @param findDescription Description of the tasks to find.
     * @return Returns a list of the tasks found.
     */

Example from src/main/java/duke/List.java lines 120-123:

    /**
     * Sort the tasks in the task list by their task type.
     * Also sorts deadline tasks and event tasks by their local date time.
     */

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 👍

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