Skip to content

Commit

Permalink
updating mentoring.md with further instructions and orientations.
Browse files Browse the repository at this point in the history
  • Loading branch information
gablemathias committed Sep 12, 2024
1 parent 0f2aaf9 commit 3627f54
Showing 1 changed file with 28 additions and 3 deletions.
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,
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

0 comments on commit 3627f54

Please sign in to comment.