Sharing iP code quality feedback [for @javierng2knus]

[soc-se-bot-blue]

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

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/jav/Jav.java lines 60-62:

    /**
     * Forcefully shuts down the program.
     */

Example from src/main/java/jav/manager/StorageManager.java lines 112-118:

    /**
     * Update whether a specific task is marked or not.
     *
     * @param index the index of the task.
     * @param shouldMark whether the task should be marked.
     * @return whether the specified task exists or not.
     */

Example from src/main/java/jav/manager/StorageManager.java lines 170-172:

    /**
     * Load the saved data into the storage.
     */

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 add1097:

Improve code quality

Improve code quality with addition of guard clauses and better naming.

The goal is to maximize readability by avoiding deep nesting with arrowhead-like shapes and making the happy path more prominent with the addition of guard clauses.
Additionally there is some modification to the vague naming done regarding Booleans.

• body not wrapped at 72 characters: e.g., The goal is to maximize readability by avoiding deep nesting with arrowhead-like shapes and making the happy path more prominent with the addition of guard clauses.

possible problems in commit 0bb7681:

Refactor text UI to GUI

Refactor all relevant UI code such as the responses to commands to properly reflect in the new GUI.

The goal is to make use of the previously implemented JavaFX technology and convert all of the existing text UI to the new GUI.

• body not wrapped at 72 characters: e.g., Refactor all relevant UI code such as the responses to commands to properly reflect in the new GUI.

possible problems in commit 2fe86e7:

Integrate basic GUI

Integrate basic GUI via JavaFX.

The goal is to use the JavaFX technology to implement the GUI and replace the previous text-based UI.

Guide found here: https://se-education.org/guides/tutorials/javaFx.html

• body not wrapped at 72 characters: e.g., The goal is to use the JavaFX technology to implement the GUI and replace the previous text-based UI.

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 👍

---

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