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/parser/Parser.java
lines 32-36
:
/**
* <code>help()</code> shows a list of usable commands that the user can enter into the bot.
*
* @return a string which shows the list of possible user commands
*/
Example from src/main/java/duke/parser/Parser.java
lines 45-49
:
/**
* <code>list()</code> reads the current TaskList and shows a list of tasks the user has so far.
*
* @return listDialog, a string which shows the current list of tasks
*/
Example from src/main/java/duke/parser/Parser.java
lines 56-63
:
/**
* <code>markTaskAsDone(String input)</code> marks a task at a specific index as done
*
* @param input input string in the GUI, should contain the index for the task to be marked as done
*
* @return a dialog string showing the task marked as done,
* shows an error message if there are no tasks or task number 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
Suggestion: Avoid committing binary files (e.g., *.class
, *.jar
, *.exe
) or third-party library files in to the repo.
โ 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 @nus-se-bot 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.