Sharing iP code quality feedback [for @Halpfrog]

[nus-se-bot]

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

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

package Duke.Exception;

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

package Duke.Processing;

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

package Duke.Processing;

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

Aspect: Class Name Style

Example from src/main/java/Duke/tasks/todo.java lines 3-3:

public class todo extends Task{

Example from src/Test/java/eventTest.java lines 11-11:

public class eventTest {

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

Aspect: Dead Code

Example from src/main/java/Duke/Processing/Parser.java lines 16-16:

        //System.out.println(date);

Example from src/main/java/Duke/Processing/Parser.java lines 31-31:

        //System.out.println(date);

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

                //System.out.println(sc.nextLine());

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

No easy-to-detect issues 👍

Aspect: Recent Git Commit Message (Subject Only)

possible problems in commit 1e08328:

Added find functionality

• Not in imperative mood (?)

possible problems in commit bfb320d:

Fixed according to coding standard

• Not in imperative mood (?)

possible problems in commit 1f3b593:

Added javadocs

• Not in imperative mood (?)

Suggestion: Follow the given conventions for Git commit messages for future commits (no need to modify past commit messages).

Aspect: Binary files in repo

• src\main\java\todo.class

Suggestion: Avoid committing binary files (e.g., *.class, *.jar, *.exe) or third-party library files in to the repo.

ℹ️ 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 cs2103@comp.nus.edu.sg if you want to follow up on this post.