@c0j0s 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/database/DukeRepo.java
lines 31-37
:
/**
* Add an entry to database.
*
* @param task {@link Task} object a specific task
* @return {@link Task} object a specific task
* @throws DatabaseCloseException if database was closed
*/
Example from src/main/java/duke/database/DukeRepo.java
lines 40-46
:
/**
* Update an entry from database by id
*
* @param taskId int task id in the list
* @return {@link Task} object a specific task
* @throws DatabaseCloseException
*/
Example from src/main/java/duke/database/DukeRepo.java
lines 49-56
:
/**
* Remove an entry from database by id
*
* @param taskId
* @return {@link Task} object a specific task
* @throws DatabaseCloseException if database was closed
* @throws IndexOutOfBoundsException if task id is invalid
*/
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)
No easy-to-detect issues ๐
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.