Sharing iP code quality feedback [for @noahang]

[nus-se-script]

@noahang 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/backend/ToDoList.java lines 98-103:

    /**
     * Delete a task in the list.
     * If the task does not exist, informs user that the task does not exist.
     *
     * @param index the index of the task in the <code>ArrayList toDoList</code>
     */

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

extract functionality of command parsing into Parser.java class, extract functionality of UI from all other classes into SirDuke.java, add Main class

• Longer than 72 characters

possible problems in commit 21f9da9:

add implementation for toFileEntry() method in DeadlineTask.java, ToDoTask.java

• Longer than 72 characters

possible problems in commit 759db4a:

replace toString method with getStatusIcon and toFileEntry method

this allows us to write tasks as file entries into the hard disk in a standardised format

• body not wrapped at 72 characters: e.g., this allows us to write tasks as file entries into the hard disk in a standardised format

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.