Sharing iP code quality feedback [for @skythefire]

[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/Task.java lines 5-5:

    private boolean completed;

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

Example from src/main/java/duke/Duke.java lines 28-28:

//    public void run() {

Example from src/main/java/duke/Duke.java lines 29-29:

//        boolean isExit = false;

Example from src/main/java/duke/Duke.java lines 31-31:

//        while (!isExit) {

Suggestion: Remove dead code from the codebase.

Aspect: Method Length

No easy-to-detect issues 👍

Aspect: Header Comments

Example from src/main/java/duke/Ui.java lines 18-20:

    /**
     * Message to be seen by user upon closing the program.
     */

Example from src/main/java/duke/Ui.java lines 25-27:

    /**
     * Message to be seen by user if hard disk file does not exist.
     */

Example from src/main/java/duke/Ui.java lines 32-36:

    /**
     * Prefix for error messages.
     *
     * @param msg The error message
     */

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)

possible problems in commit 42c7ad5:

Added GUI for Duke

• Not in imperative mood (?)

Suggestion: Follow the given conventions for Git commit messages

ℹ️ 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.