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

[soc-se-bot]

@anshumaantgi 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/Ava/tasks/Task.java lines 6-6:

    protected boolean marked = 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/main/java/Ava/Ava.java lines 1-1:

package Ava;

Example from src/main/java/Ava/DialogBox.java lines 1-1:

package Ava;

Example from src/main/java/Ava/Launcher.java lines 1-1:

package Ava;

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

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/Ava/TaskList.java lines 26-29:

    /**
     * Add Task to the list and increments taskCount
     * @param t Task Object
     */

Example from src/main/java/Ava/TaskList.java lines 52-57:

    /**
     * mark task from List
     * @param index int indicate index of task to be marked
     * @return marked task
     * @throws NonExistentTask indicate task does not exist
     */

Example from src/main/java/Ava/TaskList.java lines 67-72:

    /**
     * unmark task from List
     * @param index int indicate index of task to be unmarked
     * @return unmarked task
     * @throws NonExistentTask indicate task does not exist
     */

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.