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

[nus-se-bot]

@Sheeepen 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/java/helpers/ClashDetection.java lines 28-28:

        boolean res = 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/java/Duke.java lines 27-32:

    /**
     * Obtain the response message from the user input command.
     *
     * @param input The user input in the form of some command.
     * @return The message to be displayed.
     */

Example from src/main/java/tasks/TaskList.java lines 174-181:

    /**
     * Overloaded method that adds a ToDo task object to the task list
     * that specifies completion status.
     *
     * @param description Description of the ToDo object.
     * @param isDone Completion status.
     * @return The message to be displayed upon completion.
     */

Example from src/main/java/tasks/TaskList.java lines 214-222:

    /**
     * Overloaded method that adds a Deadline task object to the task list
     * that specifies completion status.
     *
     * @param description Description of the Deadline object.
     * @param end end Date/Time of the Deadline object.
     * @param isDone Completion status.
     * @return The message to be displayed upon completion.
     */

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.