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

[soc-se-bot-blue]

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

Example from src/main/java/taskObjects/Event.java lines 1-1:

package taskObjects;

Example from src/main/java/taskObjects/AbstractTask.java lines 1-1:

package taskObjects;

Example from src/main/java/taskObjects/Deadline.java lines 1-1:

package taskObjects;

Suggestion: Follow the package naming convention specified by the coding standard.

Aspect: Class Name Style

No easy-to-detect issues 👍

Aspect: Dead Code

Example from src/test/java/datastructure/TaskListTest.java lines 23-23:

//        AbstractTask task1 = new Todo("Test task1", false);

Example from src/test/java/datastructure/TaskListTest.java lines 24-24:

//        AbstractTask task2 = new Todo("Test task2", false);

Example from src/test/java/datastructure/TaskListTest.java lines 25-25:

//        taskList.add(task1);

Suggestion: Remove dead code from the codebase.

Aspect: Method Length

No easy-to-detect issues 👍

Aspect: Class size

No easy-to-detect issues 👍

Aspect: Header Comments

Example from src/main/java/app/Daiyan.java lines 81-86:

    /**
     * The main entry point of the Daiyan application.
     * It initializes and runs the application with the specified storage file path.
     *
     * @param args Command-line arguments (not used).
     */

Example from src/main/java/enums/CommandTypes.java lines 22-27:

    /**
     * Static method to parse command from String to the respective enum
     *
     * @param command raw String input of the command
     * @return String formatted to uppercase or Invalid if not found in enum
     */

Example from src/main/java/controller/Storage.java lines 83-89:

    /**
     * Util function to parse plain text data into {@code AbstractTask} class
     *
     * @param input raw String input from the data
     * @return {@code AbstractTask} class respective to the String input
     * @throws InvalidInputException if input is invalid or in wrong format
     */

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 Messages

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.