Sharing iP code quality feedback [for @CXl0l0]

[nus-se-bot]

@CXl0l0 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/sigma/task/TaskList.java lines 59-65:

    /**
     * Add the indicated To Do task into TaskList. 
     * 
     * @param taskName The name of the task.
     * @return The ToDo task created.
     * @throws NoTaskNameException If taskName is empty.
     */

Example from src/main/java/sigma/task/TaskList.java lines 77-84:

    /**
     * Add the indicated Deadline task into TaskList. 
     * 
     * @param taskName The name of the task.
     * @param date The deadline date of the task.
     * @return The deadline task created.
     * @throws SigmaException If the inputs are erroneous.
     */

Example from src/main/java/sigma/task/TaskList.java lines 96-104:

    /**
     * Add the indicated Event task into TaskList. 
     * 
     * @param taskName The name of the task.
     * @param from The starting date of the event.
     * @param to The ending date of the event.
     * @return The event task created.
     * @throws SigmaException If the inputs are erroneous.
     */

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 5c1d327:

Make Ui class handles more about the user interface.

• Subject line should not end with a period

possible problems in commit 7fa788b:

Add JavaDoc documentation to most of the classes and functions.

• Subject line should not end with a period

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.