Sharing iP code quality feedback [for @AngPengXuan]

[soc-se-script]

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

Example from src/main/java/pixel/Parser.java lines 33-33:

        boolean valid = 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

Example from src/main/java/pixel/command/SortCommand.java lines 38-38:

        // taskList.addTask(this.task);

Example from src/main/java/pixel/command/SortCommand.java lines 41-41:

        // + " tasks in the list.");

Example from src/main/java/pixel/task/TaskList.java lines 87-87:

        // list.sort((task1, task2) -> task1.toString().compareTo(task2.toString()));

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/pixel/Pixel.java lines 67-73:

    /**
     * The entry point of the Pixel application. It creates a new instance of Pixel
     * and runs the application.
     *
     * @param input The input command.
     * @return The response message from the Pixel application.
     */

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 👍

---

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