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

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

No easy-to-detect issues 👍

Aspect: Brace Style

No easy-to-detect issues 👍

Aspect: Package Name Style

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

package Duke;

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;

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/deadlineTest.java lines 10-10:

public class deadlineTest {

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

public class eventTest {

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

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

No easy-to-detect issues 👍

Aspect: Recent Git Commit Message (Subject Only)

No easy-to-detect issues 👍

Aspect: Binary files in repo

• src\main\java\Duke.class

• src\main\java\Duke\Exception\DukeException.class

• src\main\java\Duke\Processing\Parser.class

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

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