Sharing iP code quality feedback [for @zm-l] - Round 2 #3
Description
@zm-l 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
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/Duke.java lines 23-26:
/**
* Initializing the storage, ui and task list.
* @param filePath the file path for the storage
*/Example from src/main/java/duke/storage/Storage.java lines 33-37:
/**
* Write at the end of file.
* @param filePath the path of the file to be written.
* @param textToAppend the text to be appended.
*/Example from src/main/java/duke/storage/Storage.java lines 44-49:
/**
* Write marking to a specific line on the file.
* @param filePath the path of the file to be written.
* @param mark the marking to be written.
* @param line the line to be written.
*/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 15e9c19:
a
- Perhaps too short (?)
possible problems in commit c8e1b97:
a
- Perhaps too short (?)
Suggestion: Follow the given conventions for Git commit messages for future commits (no need to modify past commit messages).
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 [email protected] if you want to follow up on this post.