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

[nus-se-script]

@zunedz 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/duke/task/TaskList.java lines 24-30:

    /**
     * Add a new task into the tasks list. will return the string to be printed
     * by the Ui
     *
     * @param newTask new task to be added into the list
     * @return String to be printed by the Ui containing information of the task.
     */

Example from src/main/java/duke/task/TaskList.java lines 40-44:

    /**
     * return the current number of tasks inside the list
     *
     * @return number of tasks inside the list
     */

Example from src/main/java/duke/task/TaskList.java lines 67-75:

    /**
     * Change the state of specified task, from checked to unchecked and
     * vice versa.
     *
     * @param id specified task to be modified
     * @param instr the instruction to be done, either mark or unmark
     * @return  String contains the information of the modified task
     * @throws InvalidTaskNumberException If id > index or id <= 0 (can't modify)
     */

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 (Subject Only)

No easy-to-detect issues 👍

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.