[Teo Ziyi Ivy] iP by teoziyiivy · Pull Request #182 · nus-cs2113-AY2122S1/ip

teoziyiivy · 2021-09-01T04:17:40Z

Added Levels-0-3 and A-CodingStandard

This reverts commit de9dc0a.

jonathanmui4

Hey, I like how clean your code is and how most of your code complies with Java coding standards. Perhaps, you can consider adding some Javadoc documentation to your methods to help other users better understand your code. Great Job! 😃

jonathanmui4 · 2021-09-03T01:28:45Z

src/main/java/Deadline.java

+    public void printTask() {
+        System.out.print("[D][" + getStatusIcon() + "] " + getDescription());
+        System.out.println("(by:" + by + ")");
+    }


Perhaps you can refactor this to a ToString() method. This way, you can print out the object directly without having to call a method:
System.out.println(deadlineObject);

jonathanmui4 · 2021-09-03T01:34:18Z

src/main/java/Duke.java

+        String description = line.replaceAll("/.+", "");
+        String by = line.replaceAll(".+/at", "");
+        tasks[taskCount] = new Event(description, by);
+        taskCount = taskCount + 1;


Perhaps you can consider shortening this line to taskCount++

jonathanmui4 · 2021-09-03T01:37:34Z

src/main/java/Duke.java

+            tasks[i].printTask();
+        }
+    }
+    public static void TaskDone(int index) {


Perhaps, the function name markAsDone would be a better name as it sounds more intuitive when you are accomplishing the task with this function call. In addition, you can consider Camel Casing while naming this function too.

jonathanmui4 · 2021-09-03T04:34:53Z

src/main/java/Duke.java

+import java.util.Scanner;
+
 public class Duke {
+    public static Task[] tasks = new Task[100];


I really like how you named the array in its plural form of "tasks". It sounds more intuitive

ianwangeeen · 2021-09-03T05:04:43Z

src/main/java/Duke.java

+    public static void printConfused() {
+        System.out.println("Could you say that again?");
+    }
+    public static void printExit() {


I think adding a space after every method would make your code seem more readable and neater.

ianwangeeen · 2021-09-03T05:06:02Z

src/main/java/Duke.java

+        Scanner in = new Scanner(System.in);
+        line = in.nextLine();
+        //continue to run program unless types "bye" to exit program
+        while (!line.equals("bye")) {


I do not really like the main function as it contains quite a few low level programming lines. Perhaps you could put them inside a separate method and then call this method in the main function.

ianwangeeen · 2021-09-03T05:08:08Z

src/main/java/Duke.java

+        taskCount = taskCount + 1;
+        printTaskTypeResponse();
+    }
+    public static void addEvent(String line) {


I like that you had good naming conventions for your methods, apart from your TaskDone method, mentioned by jonathanmui4.

ianwangeeen · 2021-09-03T05:09:27Z

src/main/java/Deadline.java

@@ -0,0 +1,19 @@
+public class Deadline extends Todo{


For your overall code, I think it would be more readable if you could add in comments at the top of each method/function.

ianwangeeen · 2021-09-03T05:11:46Z

src/main/java/Duke.java

+                addEvent(line);
+            } else {
+                //error with input
+                printConfused();


I like that you have included some error catching method.

zikunz

Great work Ivy! You have definitely followed various coding guidelines and your Duke is so awesome! 💯

Overall, this version of code is very easy to understand and is very readable except for very few potential and minor coding standard and quality-related violations. Keep up the good work :D

zikunz · 2021-09-14T09:19:10Z

src/main/java/duke/Deadline.java

@@ -0,0 +1,21 @@
+package duke;


Great to see that you organise your types (e.g., classes) into a package for easier management!

zikunz · 2021-09-14T10:16:56Z

src/main/java/duke/Duke.java

+    public static void printGreeting() {
+        System.out.println("Hello! I'm Duke\n" + "What can I do for you?");
+    }
+
+    public static void printConfused() {
+        System.out.println("Could you say that again?");
+    }
+
+    public static void printExit() {
+        System.out.println("Bye. Hope to see you again soon!");
+    }
+
+    public static void printGotIt() {
+        System.out.println("Got it. I've added this task:");
+    }
+
+    public static void printTaskCount() {
+        System.out.println("Now you have " + taskCount + " tasks in the list.");
+    }
+
+    public static void printTodoException() {
+        System.out.println("The description of todo cannot be empty.");
+    }
+
+    public static void printDeadlineException() {
+        System.out.println("The description of deadline cannot be empty.");
+    }
+
+    public static void printEventException() {
+        System.out.println("The description of event cannot be empty.");
+    }
+
+    public static void printDoneException() {
+        System.out.println("The description of done cannot be empty.");
+    }


Great to see that you have created many helper print functions here! Perhaps you could also extract these final strings (also found in other parts of the code such as line 53) out as constants and put them into a new Message class later on?

zikunz · 2021-09-14T11:36:59Z

src/main/java/duke/Deadline.java

@@ -0,0 +1,21 @@
+package duke;
+
+public class Deadline extends Todo{


Perhaps you could leave a space here before { for layout consistency. Similar styles also happen in line 3 of DeadlineException class.

zikunz · 2021-09-14T11:38:32Z

src/main/java/duke/Deadline.java

+    }
+
+    public void printTask() {
+        System.out.print("[D][" + getStatusIcon() + "] " + getDescription());


According to https://nus-cs2113-ay2122s1.github.io/website/se-book-adapted/chapters/codeQuality.html#avoid-magic-numbers, perhaps you could spend some time trying to avoid all sorts of magic strings (there are also found elsewhere such E in Event class) to further improve readability?

zikunz · 2021-09-14T11:42:54Z

src/main/java/duke/Duke.java

+    }
+
+    public static void printTaskTypeResponse() {
+        //printing different responses depending if its duke.Todo/duke.Deadline/duke.Event


You could consider removing this comment and use JavaDoc comments for non-private classes / methods and non-trivial private methods in an appropriate way, as per https://nus-cs2113-ay2122s1.github.io/website/se-book-adapted/chapters/documentation.html#javadoc. The same applies to line 85.

zikunz · 2021-09-14T11:48:50Z

src/main/java/duke/Task.java

+        // mark done task with X
+        return (isDone ? "X" : " ");


I like how your comment is indented relative to its position in the code. Good job!

zikunz · 2021-09-14T11:49:22Z

src/main/java/duke/Deadline.java

+    public void setBy(String by) {
+        this.by = by;
+    }


Precise setter name, good job!

zikunz · 2021-09-14T11:53:47Z

src/main/java/duke/Task.java

+
+public class Task {
+    protected String description;
+    protected boolean isDone;


I like how your use the is prefix here to make your boolean attribute sound like valid booleans.

zikunz · 2021-09-14T12:02:36Z

src/main/java/duke/Duke.java

+        }
+    }
+
+    public static void taskDone(String line) throws DoneException {


Perhaps you could rephrase the method name here so that it starts with a verb according to https://se-education.org/guides/conventions/java/index.html#naming.

zikunz · 2021-09-14T12:03:29Z

src/main/java/duke/Duke.java

+    }
+
+    public static void readInput(String line) {
+        String[] splitLine = line.split(" ", 2);


Perhaps you could also spend some time to avoid having magic numbers as well.

Level-9

teoziyiivy added 5 commits August 24, 2021 14:42

Level 0: Greet

a05464f

Level-1

efd9e5b

Level-2

99d6469

Level-3

1814bd1

A-CodingStandard

0e868fe

teoziyiivy changed the title ~~Add Level-0, Level-1, Level-2, Level-3 and A-CodingStandard~~ [Teo Ziyi Ivy] iP Sep 1, 2021

teoziyiivy added 8 commits September 1, 2021 23:44

Level-4

de9dc0a

Revert "Level-4"

0061596

This reverts commit de9dc0a.

Fixing accidental revert

860304e

Incomplete A-TextUiTesting

466cbee

A-CodeQuality

781043a

Shifting comment line

50e7e6b

Altering runtest.bat

a6b0cb4

A-TextUiTesting update

81aba61

jonathanmui4 reviewed Sep 3, 2021

View reviewed changes

ianwangeeen reviewed Sep 3, 2021

View reviewed changes

teoziyiivy added 3 commits September 9, 2021 00:10

Level-5

dcd1d91

A-Packages

63405a4

Updated runtest and exceptions.

9096123

zikunz reviewed Sep 14, 2021

View reviewed changes

teoziyiivy and others added 10 commits September 15, 2021 00:00

Reformat files, add branch-Level-6, Level-6 and A-Collections

f6335dc

Add Level-7

a5faa2b

Resolve merge conflict

8d4fd35

Additional resolving of merge conflicts

d17bf94

Bug fixes

890f18e

A-MoreOOP

43da2b2

Level-9

e39676b

Merge pull request #1 from teoziyiivy/branch-Level-9

55b724b

Level-9

A-JavaDoc

76199bd

Customisation and User guide

a87decb

Edit txt files

a5be714

		@@ -0,0 +1,21 @@
		package duke;

		public class Deadline extends Todo{

Conversation

teoziyiivy commented Sep 1, 2021

Uh oh!

jonathanmui4 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

zikunz left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

zikunz Sep 14, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

zikunz Sep 14, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

zikunz Sep 14, 2021 •

edited

Loading

zikunz Sep 14, 2021 •

edited

Loading