Sharing iP code quality feedback [for @tyxiangs] - Round 2 #5
Description
@tyxiangs 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/Launcher.java lines 8-12:
/**
* The main method that serves as the entry point for the application.
*
* @param args Command-line arguments passed to the application.
*/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 e36e7e9:
docs(README): update documentation to reflect current program features
Updated the README to ensure it is consistent with the latest version of the program. Changes include:
- Added new instructions that match the current functionality.
- Updated usage examples and feature descriptions.
This ensures the documentation is up-to-date and aligned with the program's current state.
- body not wrapped at 72 characters: e.g.,
Updated the README to ensure it is consistent with the latest version of the program. Changes include:
possible problems in commit 1ca150a:
feat: Add Deadline class with due date parsing and tests
- Implement Deadline class to support tasks with deadlines.
- Parse date and time using "yyyy-MM-dd HHmm" format with error handling.
- Add test case for valid deadline creation to ensure correct date and time parsing.
- Ensure compatibility with Java 17 as required for project submission.
- body not wrapped at 72 characters: e.g.,
- Parse date and time using "yyyy-MM-dd HHmm" format with error handling.
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.