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

[nus-se-bot]

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

Example from src/main/java/duke/parser/CommandDeadline.java lines 42-42:

        boolean success = false;

Example from src/main/java/duke/parser/CommandEvent.java lines 39-39:

        boolean success = false;

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

        boolean success = false;

Suggestion: Follow the given naming convention for boolean variables/methods (e.g., use a boolean-sounding prefix).You may ignore the above if you think the name already follows the convention (the script can report false positives in some cases)

Aspect: Brace Style

No easy-to-detect issues 👍

Aspect: Package Name Style

Example from src/test/java/duke/StorageTests/StorageTaskListTest.java lines 1-1:

package duke.StorageTests;

Example from src/test/java/duke/TaskTests/DeadlineTest.java lines 1-1:

package duke.TaskTests;

Example from src/test/java/duke/TaskTests/EventTest.java lines 1-1:

package duke.TaskTests;

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

Aspect: Class Name Style

No easy-to-detect issues 👍

Aspect: Dead Code

Example from src/main/java/duke/storage/StorageFixedDurationReference.java lines 25-25:

        //this.fileName = fileName;

Suggestion: Remove dead code from the codebase.

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/Duke.java lines 16-20:

    /**
     * Beginning function taking in filepath
     *
     * @param filePath - filepath to storage
     */

Example from src/main/java/duke/task/Task.java lines 66-70:

    /**
     * Base Function to print task.
     *
     * @return tasks [] TASK.
     */

Suggestion: Ensure method/class header comments follow the format specified in the coding standard, in particular, the phrasing of the overview statement

ℹ️ The bot account @nus-se-bot used to post this issue is un-manned. Do not reply to this post (as those replies will not be read). Instead, contact tic2002@comp.nus.edu.sg if you want to follow up on this post.