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

[nus-se-script]

@sandyk0105 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/rei/Task.java lines 30-33:

    /**
     * Get the task name
     * @return the task name
     */

Example from src/main/java/rei/Task.java lines 133-136:

    /**
     * String representation of all the tags
     * @return all the tags
     */

Example from src/main/java/rei/TaskList.java lines 123-128:

    /**
     * Add a list of tags into a Task
     * @param taskIndex the Task index
     * @param tags the list of tags
     * @return the message, whether the process succeeds or fails
     */

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

possible problems in commit 5715ccb:

Clean up imports and improve documentation

Clean up imports and improve documentation

Unused imports in Rei.java clutter the code and can lead to confusion.

Cleaning up these imports will enhance code readability and maintainability.

Let’s remove unused imports in Rei.java, specify the imports used in
Storage.java instead of using an asterisk, and fix a typo in
Storage.java. Additionally, Javadocs will be added for the
ReiException.java class to improve clarity and documentation.

These changes contribute to a cleaner codebase and better
documentation, making it easier for developers to understand and
work with the code.

• body not wrapped at 72 characters: e.g., Cleaning up these imports will enhance code readability and maintainability.

possible problems in commit 92187dd:

Refactor storage system: switch from Path to File to resolve loading issues

The storage system currently uses Path for file
handling, which fails when loading new files.

This needs to change because the failure to load new files indicates
compatibility issues and limitations in file operations.

Adapted from github.com/adipanda2002/ip .

• Longer than 72 characters

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

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.