Sharing iP code quality feedback [for @B1LLP4RK] #3
Description
@B1LLP4RK 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
Example from src/main/java/duke/Task.java lines 9-9:
protected boolean finished;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
No easy-to-detect issues 👍
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/duke/command/CommandDeadline.java lines 18-23:
/**
* Contructor for CommandDeadline.
* @param taskList List of tasks to modify after this command.
* @param deadlineContent Description of the task to be added.
* @param date Due date of the task to be added.
*/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 20aa94d:
Merge branch 'add-gradle-support' of https://github.com/B1LLP4RK/ip into branch-A-Gradle
- Longer than 72 characters
Suggestion: Follow the given conventions for Git commit messages for future commits (no need to modify past commit messages).
ℹ️ 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 [email protected] if you want to follow up on this post.