Sharing iP code quality feedback [for @Casielim]

[nus-se-script]

@Casielim 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/vera/Vera.java lines 19-23:

    /**
     * Construct a Vera Chatbot instance.
     * Initialize ui, storage as well as a task list with content loaded from storage file.
     * Initialized a new empty task list if error occur loading the content.
     */

Example from src/main/java/vera/Vera.java lines 35-38:

    /**
     * Run the chatbot to allow users input their command.
     * Chatbot will keep running until the "bye" command is detected.
     */

Example from src/main/java/vera/tasks/TaskList.java lines 174-181:

    /**
     * Change date time of a Deadline task or Event Task.
     *
     * @param index The index of task to be updated.
     * @param newTimes Updated by time for Deadline task or from and to task for Event task.
     * @return A String of updated date time
     * @throws VeraException If the task format is incorrect.
     */

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 👍

---

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