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

[soc-se-bot-blue]

@cerulyean 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/doot/TaskList.java lines 71-74:

    /**
     * used for saving. This assembles the creationString() of all tasks and seperates them in their own lines
     * @return the strings needed to recreate the list
     */

Example from src/main/java/doot/Parser.java lines 122-126:

    /**
     * Used to parse the details to make the corresponding TodoTask
     * @param details the userInput string but without the todo at the front
     * @return the TodoTask to be created
     */

Example from src/main/java/doot/Task.java lines 21-26:

    /**
     * static class used to make a new class, then returns said class
     * @param str the userInput
     * @return a new task
     * @throws InvalidFormatException for if some of the formatting is invalid
     */

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

possible problems in commit 52930ac:

feat(tasks): add mark/unmark commands with existing state checks

Implemented mark and unmark commands that recognize when a task is already marked or unmarked.

• body not wrapped at 72 characters: e.g., Implemented mark and unmark commands that recognize when a task is already marked or unmarked.

possible problems in commit bbc97bf:

feat(tasks): add mark/unmark commands with existing state checks

Implemented mark and unmark commands that recognize when a task is already marked or unmarked.

• body not wrapped at 72 characters: e.g., Implemented mark and unmark commands that recognize when a task is already marked or unmarked.

possible problems in commit b416bc9:

chore(dependencies): add Linux and Mac support for JavaFX dependencies

Updated the dependencies to include Linux and Mac classifiers for JavaFX modules alongside the existing Windows support.

• body not wrapped at 72 characters: e.g., Updated the dependencies to include Linux and Mac classifiers for JavaFX modules alongside the existing Windows support.

Suggestion: Follow the given conventions for Git commit messages for future commits (do not modify past commit messages as doing so will change the commit timestamp that we used to detect your commit timings).

Aspect: Binary files in repo

• /Users/damithch/Repos/folder_for_temp_data/AY2425S2/cs2103/./ip/ip/cerulyean/src/out/production/ip/doot/Doot$InvalidFormatException.class

• /Users/damithch/Repos/folder_for_temp_data/AY2425S2/cs2103/./ip/ip/cerulyean/src/out/production/ip/doot/Doot$TaskList.class

• /Users/damithch/Repos/folder_for_temp_data/AY2425S2/cs2103/./ip/ip/cerulyean/src/out/production/ip/doot/Doot$Type.class

Suggestion: Avoid committing binary files (e.g., *.class, *.jar, *.exe) or third-party library files in to the repo.

---

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