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

[soc-se-bot-red]

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

Example from src/test/java/seedu/SirDuke/backend/ToDoListTest.java lines 1-1:

package seedu.SirDuke.backend;

Example from src/test/java/seedu/SirDuke/backend/command/DeadlineCommandTest.java lines 1-1:

package seedu.SirDuke.backend.command;

Example from src/main/java/seedu/SirDuke/Parser.java lines 1-1:

package seedu.SirDuke;

Suggestion: Follow the package naming convention specified by the coding standard.

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/seedu/SirDuke/SirDuke.java lines 23-25:

    /**
     * Create a new SirDuke chatbot class
     */

Example from src/main/java/seedu/SirDuke/SirDuke.java lines 57-59:

    /**
     * Clear resources and Shut down Reminderebot
     */

Example from src/main/java/seedu/SirDuke/backend/Storage.java lines 54-58:

    /**
     * Read the string entry and return a task
     * @param entry the entry representing a task object
     * @return Task corresponding to string
     */

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 8cc263e:

Add Junit tests for DeadlineCommand and ToDoList

Add test for execute() method of DeadlineCommand and createToDoTask() method of ToDoList. Refactor all classes into seedu package to allow for JUnit tests to work.

• body not wrapped at 72 characters: e.g., Add test for execute() method of DeadlineCommand and createToDoTask() method of ToDoList. Refactor all classes into seedu package to allow for JUnit tests to work.

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.