Sharing iP code quality feedback [for @EvaderFati]

[nus-se-bot]

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

Example from src/main/java/duke/data/task/Task.java lines 34-34:

[TAB]public void unmarkAsDone() {

Example from src/main/java/duke/data/task/Task.java lines 35-35:

[TAB][TAB]this.isDone = false;

Example from src/main/java/duke/data/task/Task.java lines 36-36:

[TAB]}

Suggestion: As specified by the coding standard, use spaces instead of tabs.

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/Duke.java lines 151-155:

    /**
     * Iteration 2:
     * Creates two dialog boxes, one echoing user input and the other containing Duke's reply and then appends them to
     * the dialog container. Clears the user input after processing.
     */

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

    /**
     * You should have your own function to generate a response to user input.
     * Replace this stub with your completed method.
     */

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

    /**
     * Read a line of command.
     *
     * @return the command line
     */

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 3276d06:

Merge remote-tracking branch 'origin/add-gradle-support' into branch-A-Gradle

• Longer than 72 characters

Suggestion: Follow the given conventions for Git commit messages for future commits (no need to modify past commit messages).

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