Sharing iP code quality feedback [for @15-Manya] #4
Description
@15-Manya 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
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
No easy-to-detect issues 👍
Aspect: Recent Git Commit Messages
possible problems in commit b5d2d46:
Add assertions to the document
It is harder to identify bugs during testing when documentation of assumptions are violated during development. Java assertions provide a way to document these assumptions in code and catch violations early on.
Let's add assertions to key classes:
1. AgentSmith: Verify filePath is valid, fields are initialized after constructor, and task is not null before adding
2. TaskList: Verify constructor input, task operations modify state correctly (size changes, done status updates)
3. Storage: Verify filePath and line inputs are valid before parsing
Assertions catch bugs immediately at their source, rather than allowing errors to propagate and cause hard-to-debug
- body not wrapped at 72 characters: e.g.,
It is harder to identify bugs during testing when documentation of assumptions are violated during development. Java assertions provide a way to document these assumptions in code and catch violations early on.
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
Suggestion: Avoid committing binary files (e.g., *.class, *.jar, *.exe) or third-party library files in to the repo.
ℹ️ 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@nus.edu.sg if you want to follow up on this post.