Skip to content
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
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Changes from 1 commit
Commits
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
31 changes: 28 additions & 3 deletions tracks/csharp/exercises/beer-song/beer-song/mentoring.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,35 @@
## Mentoring
The student would normally go first using the if/else and if/else if statements.
Suggesting the use of case statements first will be optimal and instructive.

The student would normally go first using the if/else and if/else if statements. That's not wrong,
Copy link
Member

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.

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
Try and guide the student towards this solution.
Guide the student towards a solution closer to this.

```csharp
public static class BeerSong
{
Expand Down
Loading