From 13510c0ab486ea1bfc4591427babace3dc9a64ee Mon Sep 17 00:00:00 2001 From: Sander Ploegsma Date: Mon, 22 Jan 2024 14:30:13 +0100 Subject: [PATCH 1/2] Add analyzer comments for Lasagna on the Java track --- analyzer-comments/java/general/exemplar.md | 5 +++++ analyzer-comments/java/general/remove_todo_comments.md | 7 +++++++ analyzer-comments/java/lasagna/reuse_code.md | 4 ++++ 3 files changed, 16 insertions(+) create mode 100644 analyzer-comments/java/general/exemplar.md create mode 100644 analyzer-comments/java/general/remove_todo_comments.md create mode 100644 analyzer-comments/java/lasagna/reuse_code.md diff --git a/analyzer-comments/java/general/exemplar.md b/analyzer-comments/java/general/exemplar.md new file mode 100644 index 000000000..e132c2be6 --- /dev/null +++ b/analyzer-comments/java/general/exemplar.md @@ -0,0 +1,5 @@ +# Exemplar + +🎉 Your solution to %s is exemplar, congratulations! +It is exactly what we think is the most idiomatic implementation of the tasks at hand. +Rejoice! diff --git a/analyzer-comments/java/general/remove_todo_comments.md b/analyzer-comments/java/general/remove_todo_comments.md new file mode 100644 index 000000000..a9ec5df4e --- /dev/null +++ b/analyzer-comments/java/general/remove_todo_comments.md @@ -0,0 +1,7 @@ +# Remove TODO comments + +It looks like you left some `// TODO: ...` comments in your code that were part of the solution stub. + +Your code passes the tests, which means those comments are no longer true - you already implemented everything that is necessary. + +Make sure to always remove outdated comments from your code. diff --git a/analyzer-comments/java/lasagna/reuse_code.md b/analyzer-comments/java/lasagna/reuse_code.md new file mode 100644 index 000000000..b65a9eafb --- /dev/null +++ b/analyzer-comments/java/lasagna/reuse_code.md @@ -0,0 +1,4 @@ +# Reuse code + +The `%s` method should reuse the logic implemented in `%s`. +Reusing existing methods can help when writing maintainable code. From 69009f6fce6df9f383d1c1ffac269b2d81fb5fd9 Mon Sep 17 00:00:00 2001 From: Sander Ploegsma Date: Mon, 22 Jan 2024 15:47:03 +0100 Subject: [PATCH 2/2] Update analyzer-comments/java/lasagna/reuse_code.md Co-authored-by: Isaac Good --- analyzer-comments/java/lasagna/reuse_code.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/analyzer-comments/java/lasagna/reuse_code.md b/analyzer-comments/java/lasagna/reuse_code.md index b65a9eafb..b78b30a2b 100644 --- a/analyzer-comments/java/lasagna/reuse_code.md +++ b/analyzer-comments/java/lasagna/reuse_code.md @@ -1,4 +1,4 @@ # Reuse code The `%s` method should reuse the logic implemented in `%s`. -Reusing existing methods can help when writing maintainable code. +Reusing existing methods can help make code easier to maintain.