Sharing iP code quality feedback [for @TLChicken]

[nus-se-bot]

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

Example from src/main/java/duke/Duke.java lines 33-33:

            //System.out.println(xmlPath.getFileName());

Example from src/main/java/duke/Duke.java lines 102-102:

        // currDuke.currUiCtrl.printWelcomeMessage();

Example from src/main/java/duke/Duke.java lines 105-105:

        // currDuke.runInputLoopMain();

Suggestion: Remove dead code from the codebase.

Aspect: Method Length

No easy-to-detect issues 👍

Aspect: Header Comments

Example from src/main/java/duke/BaseTask.java lines 132-136:

    /**
     * Check the type of task represented by the current command.
     * @param command The command inputted by the user.
     * @return the task type. Returns NONE if it is not a task.
     */

Example from src/main/java/duke/BaseTask.java lines 149-153:

    /**
     * Given the short form representing a task type, this function returns the enum representing it.
     * @param taskLetter the letter of the task type that is wanted.
     * @return the enum representing the wanted task type.
     */

Example from src/main/java/duke/DeadlineTask.java lines 19-26:

    /**
     * Used for creating a new Deadline Task.
     *
     * @param taskName the name or description of the task.
     * @param byWhen describes when the task should be completed by.
     *               (In the format: D/M/YY, DD/MM/YYYY or DD Month YYYY)
     * @throws DukeExceptionBase when the byWhen field is not given in an acceptable format.
     */

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 👍

ℹ️ The bot account @cs2103-bot 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.