clementkfj / ip Goto Github PK
View Code? Open in Web Editor NEWThis project forked from nus-cs2103-ay2122s1/ip
This project forked from nus-cs2103-ay2122s1/ip
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 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.
No easy-to-detect issues ๐
Example from src/main/java/duke/Storage.java
lines 41-41
:
boolean changed = false;
Example from src/main/java/duke/Storage.java
lines 112-112
:
boolean deleted = false;
Suggestion: Follow the given naming convention for boolean variables/methods
No easy-to-detect issues ๐
No easy-to-detect issues ๐
No easy-to-detect issues ๐
No easy-to-detect issues ๐
No easy-to-detect issues ๐
Example from src/main/java/Duke.java
lines 55-57
:
/**
* The program will begin when this method is called.
*/
Example from src/main/java/duke/Storage.java
lines 141-148
:
/**
* A method that deletes a specified task from the local memory using the method deleteLine
* function.
*
* @param toDelete The task that is to be deleted.
* @throws DukeException An error that needs to be caught due to IOException possibly being thrown
* by FileWriter
*/
Example from src/main/java/duke/TaskList.java
lines 27-32
:
/**
* Initialising new file, if file cannot be found throws an error.
*
* @param file The file that is to be copied into the list xs.
* @throws DukeException If file is not found.
*/
Suggestion: Ensure method/class header comments follow the format specified in the coding standard, in particular, the phrasing of the overview statement
No easy-to-detect issues ๐
โน๏ธ The bot account @cs2103-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.
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.
No easy-to-detect issues ๐
No easy-to-detect issues ๐
No easy-to-detect issues ๐
No easy-to-detect issues ๐
No easy-to-detect issues ๐
No easy-to-detect issues ๐
No easy-to-detect issues ๐
No easy-to-detect issues ๐
Example from src/main/java/duke/TaskList.java
lines 41-43
:
/**
* To initialise a new data/duke.txt since the user does not have one.
*/
Example from src/main/java/duke/TaskList.java
lines 76-82
:
/**
* A method that copies the list that is stored in the local file when the program starts running
* so that it is stored in the list in TaskList.
*
* @param dukeData The file that resides in the user's local memory.
* @throws DukeException An exception thrown as Scanner requires a FileNotFoundException to be handled.
*/
Example from src/main/java/duke/TaskList.java
lines 108-113
:
/**
* A method that prints a list of tasks that the user currently has in his list.
*
* @return A boolean that states whether all tasks in the list have been completed.
* @throws DukeException A message thrown as there are no items that currently are in the list.
*/
Suggestion: Ensure method/class header comments follow the format specified in the coding standard, in particular, the phrasing of the overview statement
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 @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.
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.