-
-
Notifications
You must be signed in to change notification settings - Fork 946
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.
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
Create mentoring.md for Beer Song in C# #2359
Open
gablemathias
wants to merge
2
commits into
exercism:main
Choose a base branch
from
gablemathias:patch-1
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,69 @@ | ||
## Mentoring | ||
|
||
The student would normally go first using the if/else and if/else if statements. That's not wrong, | ||
but the idea is guide him to an approach that will improve the readability and conciseness of the code. | ||
Suggesting the use of case statements first will be optimal and instructive, since the number of cases | ||
are bigger than a simple if/else. | ||
When doing this, you can reference the learning material for the switch and highlight the usability of it. | ||
Learning material: [Switch statements ](https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/statements/selection-statements) | ||
|
||
It's important to check if the student is also using clear names for the variables. | ||
|
||
The verse string in the exercise is huge and it seems to repeat in every sentence, but as the exercise | ||
explains, it's not always equal and that's why we have more than just one or two cases for it. | ||
With large strings inside the code, instructing the student to break them improves the readability. | ||
|
||
Uncle Bob from the "Clean Code" Book recommends that every line should not contain more than 120 characters. | ||
This can be challenging sometimes, but it's worthy. So in the exemplar solution we format the string | ||
using concatenation. | ||
```csharp | ||
verse += "No more bottles of beer on the wall, no more bottles of beer.\n" + | ||
"Go to the store and buy some more, 99 bottles of beer on the wall."; | ||
``` | ||
Show to the student the importance of formatting the code. It helps a lot with the comprehension | ||
and when they went back to check older code, they won't be so confused with their own code. | ||
Programmers spend more time reading than writing code. | ||
|
||
If they still feel confused about formatting, this article dive deeper into it. | ||
[Clean Code - Formatting](https://dev.to/caiocesar/clean-code-in-c-part-4-formatting-1b1h) | ||
|
||
## The Exemplar Solution | ||
Guide the student towards a solution closer to this. | ||
|
||
```csharp | ||
public static class BeerSong | ||
{ | ||
public static string Recite(int bottles, int takeDown) | ||
{ | ||
string verse = ""; | ||
|
||
for (int i = takeDown; i > 0; i--) | ||
{ | ||
switch (bottles) | ||
{ | ||
case 0: | ||
verse += "No more bottles of beer on the wall, no more bottles of beer.\n" + | ||
"Go to the store and buy some more, 99 bottles of beer on the wall."; | ||
break; | ||
case 1: | ||
verse += "1 bottle of beer on the wall, 1 bottle of beer.\n" + | ||
"Take it down and pass it around, no more bottles of beer on the wall."; | ||
break; | ||
case 2: | ||
verse += "2 bottles of beer on the wall, 2 bottles of beer.\n" + | ||
"Take one down and pass it around, 1 bottle of beer on the wall."; | ||
break; | ||
default: | ||
verse += $"{bottles} bottles of beer on the wall, {bottles} bottles of beer.\n" + | ||
$"Take one down and pass it around, {bottles - 1} bottles of beer on the wall."; | ||
break; | ||
} | ||
if (i != 1) | ||
verse += "\n\n"; | ||
|
||
bottles--; | ||
} | ||
return verse; | ||
} | ||
} | ||
``` |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Exercism markdown standard is one sentence per line.