Sharing iP code quality feedback [for @yuifuku1118]

[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

Example from src/main/java/Duke/Task.java lines 19-19:

    boolean compleated;

Example from src/main/java/Duke/TaskList.java lines 24-24:

            Boolean done = true;

Example from src/main/java/Duke/TaskList.java lines 74-74:

        boolean validCommand;

Suggestion: Follow the given naming convention for boolean variables/methods

Aspect: Brace Style

Example from src/main/java/Duke/Parser.java lines 35-36:

        }
        else{

Example from src/main/java/Duke/TaskList.java lines 77-78:

        }
        catch(InputNotValidError e){

Suggestion: As specified by the coding standard, use egyptian style braces.

Aspect: Package Name Style

Example from src/main/java/Duke/Action.java lines 1-1:

package Duke;

Example from src/main/java/Duke/Deadline.java lines 1-1:

package Duke;

Example from src/main/java/Duke/Event.java lines 1-1:

package Duke;

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: Header Comments

Example from src/main/java/Duke.java lines 40-42:

    /**
     * method to run the main process. 
     */

Example from src/main/java/Duke/Storage.java lines 37-41:

    /**
     * Method to load data from txt file,
     * returns the arraylist of tring array representation of tasks.
     * @return String array representation of tasks
     */           

Example from src/main/java/Duke/Storage.java lines 56-59:

    /**
     * Method to save data to txt file,
     * @param tasks String array representation of tasks
     */     

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)

possible problems in commit fa40a61:

mergin

• Perhaps too short (?)

possible problems in commit e84af3c:

added find

• Not in imperative mood (?)

possible problems in commit 7a8a94e:

added javadoc

• Not in imperative mood (?)

Suggestion: Follow the given conventions for Git commit messages

ℹ️ 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.