Sharing iP code quality feedback [for @zunedz]

[nus-se-bot]

@zunedz 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/duke/Duke.java lines 47-50:

    /**
     * Run the Duke chatbot to accept user input.
     * Process user's input and stopped when user input "bye"
     */

Example from src/main/java/duke/storage/Storage.java lines 24-30:

    /**
     * Load the data into tasklist if present, else create a new directory
     * to store the data and return empty tasklist.
     *
     * @return TaskList loaded from existing data
     * @throws IOException if fails to read the data.
     */

Example from src/main/java/duke/storage/Storage.java lines 65-71:

    /**
     * Update the data with the updated taskList. Create a temp file
     * to be written by the new data, replace the old data with temp
     *
     * @param taskList update taskList
     * @throws IOException if fails to write the data
     */

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 d78c083:

Code refactor, improve code quality and implement undo for mark and unmark commands

• Longer than 72 characters

possible problems in commit 9ce43f7:

Improve code quality, remove arrow-head shaped methods, change function names

• Longer than 72 characters

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

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