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

[nus-se-bot]

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

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/TaskList.java lines 41-43:

    /**
     * To initialise a new data/duke.txt since the user does not have one.
     */

Example from src/main/java/duke/TaskList.java lines 76-82:

    /**
     * A method that copies the list that is stored in the local file when the program starts running
     * so that it is stored in the list in TaskList.
     *
     * @param dukeData The file that resides in the user's local memory.
     * @throws DukeException An exception thrown as Scanner requires a FileNotFoundException to be handled.
     */

Example from src/main/java/duke/TaskList.java lines 108-113:

    /**
     * A method that prints a list of tasks that the user currently has in his list.
     *
     * @return A boolean that states whether all tasks in the list have been completed.
     * @throws DukeException A message thrown as there are no items that currently are in the list.
     */

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 👍

❗ 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 @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.