Skip to content

add comment for analyzer wizards-and-warriors-2 #2371

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
SleeplessByte merged 3 commits into from
May 19, 2025
Merged

add comment for analyzer wizards-and-warriors-2 #2371

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c019d92
add comment for analyzer wizards-and-warriors-2
chiarazarrella Apr 11, 2025
8c4a4a4
new comments for wizards-and-warriors-2
chiarazarrella May 5, 2025
cf5dd03
more meaningful name comments
chiarazarrella May 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions ...r-comments/java/wizards-and-warriors-2/reuse_code_from_describe_three_params.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Reuse code from Describe three params

The `describe(Character, Destination, TravelMethod)` method should reuse the logic implemented in `describe(Character)`, `describe(Destination)` and `describe(TravelMethod)`. Reusing existing methods can help make code easier to maintain.
4 changes: 4 additions & 0 deletions ...zer-comments/java/wizards-and-warriors-2/reuse_code_from_describe_two_params.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Reuse code from Describe two params

The `describe(Character, Destination)` method should reuse the logic implemented in `describe(Character, Destination, TravelMethod)` or in the individual methods `describe(Character)`, `describe(Destination)`, `describe(TravelMethod)`.
Copy link
Copy Markdown
Member

@kahgoh kahgoh May 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggestion for slight rewording and I don't think the describe(TravelMethod) is needed here.

Suggested change
The `describe(Character, Destination)` method should reuse the logic implemented in `describe(Character, Destination, TravelMethod)` or in the individual methods `describe(Character)`, `describe(Destination)`, `describe(TravelMethod)`.
The `describe(Character, Destination)` method should reuse the logic implemented in `describe(Character, Destination, TravelMethod)` or in the individual `describe(Character)` and `describe(Destination)` methods.

Copy link
Copy Markdown
Contributor Author

@chiarazarrella chiarazarrella May 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the describe(TravelMethod) is actually needed. In fact, the method describe(Character, Destination) can be implemented in two ways:

  1. public String describe(Character character, Destination destination) {
    return describe(character, destination, TravelMethod.WALKING);
    }

  2. public String describe(Character character, Destination destination) {
    return describe(character) + describe(destination) + describe(TravelMethod.WALKING);
    }

Without referring todescribe(TravelMethod), the student may think that one solution is also:

public String describe(Character character, Destination destination) {
return describe(character) + describe(destination) + "You're traveling to your destination by walking.";
>}

Also in design.md, they suggest to indicate it.

Copy link
Copy Markdown
Member

@kahgoh kahgoh May 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oops, you're right! The describe(TravelMethod) is needed here.

Reusing existing methods can help make code easier to maintain.