Sharing iP code quality feedback [for @Gabau]

[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/util/commands/Command.java lines 9-13:

    /**
     * The execution of a command.
     *
     * @throws DukeException When the command activity throws the exception.
     */

Example from src/main/java/duke/util/commands/CommandList.java lines 15-19:

    /**
     * Executing all the commands in the command list.
     *
     * @throws DukeException When a class in the list has the exception.
     */

Example from src/main/java/duke/util/controller/Duke.java lines 91-96:

    /**
     * Function to add a todo task
     * from just taking in a String.
     *
     * @param 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.