Sharing iP code quality feedback [for @papataco14] - Round 2 #4
Description
@papataco14 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/chad/chatengine/ChatEngine.java lines 212-215:
/**
* You should have your own function to generate a response to user input.
* Replace this stub with your completed method.
*/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
possible problems in commit 539a6cf:
Add Ui and update readme
Updated readme to serve as a user guide and added representative ui image to docs folder
- body not wrapped at 72 characters: e.g.,
Updated readme to serve as a user guide and added representative ui image to docs folder
possible problems in commit e10f000:
Improve ChatEngine class code quality
Removed redundant messages and renamed response variable to responseToUser for better clarity
- body not wrapped at 72 characters: e.g.,
Removed redundant messages and renamed response variable to responseToUser for better clarity
possible problems in commit dbd8875:
Add assert statements
This commit introduces assert statements in the Parser.java and Storage.java classes to enforce important assumptions and improve code robustness.
- body not wrapped at 72 characters: e.g.,
This commit introduces assert statements in the Parser.java and Storage.java classes to enforce important assumptions and improve code robustness.
Suggestion: Follow the given conventions for Git commit messages for future commits (do not modify past commit messages as doing so will change the commit timestamp that we used to detect your commit timings).
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 cs2103@comp.nus.edu.sg if you want to follow up on this post.