Sharing iP code quality feedback [for @chunweii]

[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

Example from src/main/java/duke/logic/CommandParser.java lines 24-24:

    private boolean willExit;

Example from src/main/java/duke/ui/TextCliUi.java lines 16-16:

    private boolean willExit;

Example from src/main/java/duke/ui/Ui.java lines 22-22:

    private boolean willExit = false;

Suggestion: Follow the given naming convention for boolean variables/methods

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/ui/Ui.java lines 61-65:

    /**
     * Called when the user wants to exit the program.
     *
     * @return the output string
     */

Example from src/main/java/duke/ui/Ui.java lines 70-76:

    /**
     * Called when the user successfully adds the task to tasklist.
     *
     * @param task       the task that is added
     * @param sizeOfList the number of tasks so far
     * @return the output string
     */

Example from src/main/java/duke/ui/Ui.java lines 84-90:

    /**
     * Called when the user removes a task from the task list.
     *
     * @param task the task that is removed or deleted
     * @param size the final size of the task list
     * @return the output string
     */

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 @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 cs2103@comp.nus.edu.sg if you want to follow up on this post.