Add documentation for HIGHLIGHT regions in README #833
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.
Summary
Added documentation to the README explaining the
#region HIGHLIGHT/#endregion HIGHLIGHTtags used throughout the source code.Problem
The README had documentation for
INCLUDE,EXCLUDE, and// EXCLUDEmarkers, but was missing documentation for theHIGHLIGHTregions that are used in 236+ files throughout the codebase. Users reading the source code would see these markers without understanding their purpose.Solution
Added a concise explanation in the "Reading the Source Code" section:
This provides readers with the context they need to understand that HIGHLIGHT regions mark code that receives special emphasis in the book, helping them identify the most important parts of each listing.
Example
For instance, in
src/Chapter13/Listing13.16.PassingADelegateWithAnExpressionLambda.cs:Readers now understand that the highlighted lambda expression is the key concept being taught in that particular listing.
Original prompt
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.