Sharing iP code quality feedback [for @LimZiJia] - Round 2

[soc-se-bot]

@LimZiJia We did an automated analysis of your code to detect potential areas to improve the code quality. We are sharing the results below, so that you can avoid similar problems in your tP code (which will be graded more strictly for code quality).

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/duke/tasks/Task.java lines 12-12:

    protected boolean done;

Example from src/test/duke/ParserTest.java lines 60-60:

        boolean thrown = false;

Suggestion: Follow the given naming convention for boolean variables/methods (e.g., use a boolean-sounding prefix).You may ignore the above if you think the name already follows the convention (the script can report false positives in some cases)

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/duke/duke/Parser.java lines 61-66:

    /**
     * The main parsing logic. Takes the input and calls the relevant functions for the desired outputs.
     *
     * @param input The string input that the user has passed into the program.
     * @return A TaskList that has been altered if there is a need to. The value is null if the command is 'bye'
     */

Example from src/main/duke/duke/Parser.java lines 128-134:

    /**
     * A helper function that is dedicated to adding tasks.
     *
     * @param inputs Array of Strings of inputs to be parsed.
     * @param command The command
     * @return The edited task list.
     */

Example from src/main/duke/tasks/Task.java lines 54-59:

    /**
     * A method that determines if a string exists in the name of this task.
     *
     * @param toFind A substring to be found in name.
     * @return True if toFind is a substring of name.
     */

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 👍

---

❗ You are not required to (but you are welcome to) fix the above problems in your iP, unless you have been separately asked to resubmit the iP due to code quality 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.