Sharing iP code quality feedback [for @highorbit25]

[nus-se-bot]

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

Example from src/main/java/Duke.java lines 95-95:

//    public void setStorage(Storage newStorage) {

Example from src/main/java/Duke.java lines 96-96:

//        storage = newStorage;

Example from src/main/java/Duke.java lines 97-97:

//    }

Suggestion: Remove dead code from the codebase.

Aspect: Method Length

No easy-to-detect issues 👍

Aspect: Class size

No easy-to-detect issues 👍

Aspect: Header Comments

Example from src/main/java/DialogBox.java lines 75-81:

    /**
     * Get a User Dialog box.
     *
     * @param text Input text by user.
     * @param img Image of user.
     * @return User Dialog box.
     */

Example from src/main/java/DialogBox.java lines 86-92:

    /**
     * Get a Duke Dialog box.
     *
     * @param text Response text by duke.
     * @param img Image of duke.
     * @return Duke Dialog box.
     */

Example from src/main/java/Duke.java lines 41-46:

    /**
     * Main method to initialise Duke.
     *
     * @param args The user input.
     * @throws DukeException If invalid command encountered.
     */

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 👍

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.