Sharing iP code quality feedback [for @jsincorporated]

[nus-se-script]

@jsincorporated 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/Deadline.java lines 15-15:

        // System.out.println(dateTime.toString());

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

//        new Duke("data/tasks.txt").run();

Example from src/main/java/duke/Event.java lines 15-15:

        // System.out.println(dateTime.toString());

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 40-43:

    /**
     * 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/GuiUserInterface.java lines 81-86:

    /**
     * Given a TaskList of query matches, returns the results.
     *
     * @param matches TaskList of query matches.
     * @return The output of Duke
     */

Example from src/main/java/duke/UserInterface.java lines 95-99:

    /**
     * Given a TaskList of query matches, prints out the results.
     *
     * @param matches TaskList of query matches.
     */

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 3c29d2a:

C-Help

• Perhaps too short (?)

possible problems in commit 5db871f:

C-Help

• Perhaps too short (?)

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

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.