Add documentation for HIGHLIGHT regions in README#833
Merged
BenjaminMichaelis merged 2 commits intov12.0from Oct 3, 2025
Merged
Add documentation for HIGHLIGHT regions in README#833BenjaminMichaelis merged 2 commits intov12.0from
BenjaminMichaelis merged 2 commits intov12.0from
Conversation
Co-authored-by: BenjaminMichaelis <22186029+BenjaminMichaelis@users.noreply.github.com>
Copilot
AI
changed the title
There are a lot of:
#region INCLUDE #endregion INCLUDE kinds of things in the code.
work on adding some light and minimal (just enough to understand how to read the source code when you see these) documentation in the readme about those if there isn't...
Add documentation for HIGHLIGHT regions in README
Oct 3, 2025
There was a problem hiding this comment.
Pull Request Overview
Adds documentation explaining the purpose of #region HIGHLIGHT / #endregion HIGHLIGHT tags used throughout the codebase to help readers understand how to interpret these markers when reading source code.
- Documents the
HIGHLIGHTregion markers that are used in 236+ files but were previously undocumented - Explains that highlighted regions indicate code emphasized in the book with special formatting
- Completes the documentation set alongside existing
INCLUDEandEXCLUDEmarker explanations
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.