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

[soc-se-bot]

@yumengtan 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/lucifer/storage/Storage.java lines 87-92:

    /**
     * Abstraction method to add the task to the tasklist if it is an Event.
     *
     * @param input data abstracted from file.
     * @param list the arraylist to save the task into.
     */

Example from src/main/java/lucifer/storage/Storage.java lines 108-113:

    /**
     * Abstraction method to add the task to the tasklist if it is a Deadline.
     *
     * @param input data abstracted from file.
     * @param list the arraylist to save the task into.
     */

Example from src/main/java/lucifer/storage/Storage.java lines 128-133:

    /**
     * Abstraction method to add the task to the tasklist if it is a ToDo.
     *
     * @param input data abstracted from file.
     * @param list the arraylist to save the task into.
     */

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 👍

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.