Sharing iP code quality feedback [for @Li-Zizhen]

[soc-se-bot-red]

@Li-Zizhen 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

Example from src/main/java/Duke/DialogBox.java lines 1-1:

package Duke;

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

package Duke;

Example from src/main/java/Duke/Launcher.java lines 1-1:

package Duke;

Suggestion: Follow the package naming convention specified by the coding standard.

Aspect: Class Name Style

No easy-to-detect issues 👍

Aspect: Dead Code

Example from src/main/java/Duke/Storage.java lines 36-36:

            //e.printStackTrace();

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/Duke/Duke.java lines 13-17:

    /**
     * Construct Duke instance, initialize application's components.
     *
     * @param filePath the path the program restore previously stored tasks.
     */

Example from src/main/java/Duke/Duke.java lines 24-26:

    /**
     * Start the application, use the loop to get user's input and process
     */

Example from src/main/java/Duke/Duke.java lines 48-52:

    /**
     * The entry point of the entire program, create a Duke instance and run it.
     *
     * @param args parameter not in use.
     */

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

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.