Sharing iP code quality feedback [for @1001mei]

[nus-se-bot]

@1001mei 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/gui/DialogBox.java lines 60-66:

    /**
     * Construct a user DialogBox.
     *
     * @param text text to be displayed in this dialog box.
     * @param img the image associated with this dialog box.
     * @return A DialogBox with specified text and image.
     */

Example from src/main/java/duke/gui/DialogBox.java lines 71-77:

    /**
     * Construct a Duke DialogBox.
     *
     * @param text text to be displayed in this dialog box.
     * @param img the image associated with this dialog box.
     * @return A DialogBox with specified text and image.
     */

Example from src/main/java/duke/gui/MainWindow.java lines 39-43:

    /**
     * Set the <code>duke</code> object.
     *
     * @param duke a Duke object.
     */

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