Sharing iP code quality feedback [for @likeabowx]

[nus-se-bot]

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

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/puke/parser/Parser.java lines 58-66:

    /**
     * Mark/unmark a task based on the command and input given.
     *
     * @param command Command to either mark/unmark.
     * @param argument Input from the user.
     * @param tasks List of tasks currently.
     * @return Response from the chat-bot.
     * @throws PukeException If the task cannot be marked/unmarked; Or the task is invalid.
     */

Example from src/main/java/puke/task/Task.java lines 54-59:

    /**
     * Check if the task name contains a specified string.
     *
     * @param s String to match in the task name.
     * @return True if the task name contains the string; False otherwise.
     */

Example from src/main/java/puke/task/TaskList.java lines 20-22:

    /**
     * Initialise an ArrayList to store the tasks.
     */

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)

No easy-to-detect issues 👍

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