Skip to content

Commit 4714298

Browse files
authored
Add documentation for HIGHLIGHT regions in README (#833)
1 parent f0e4e06 commit 4714298

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,8 @@ When you see matching `#region INCLUDE` and `#endregion INCLUDE` tags in a listi
7777

7878
When there are matching `#region EXCLUDE` and `#endregion EXCLUDE` tags in a listing, even if these are within two `INCLUDE` tags, this section is omitted from being visible in the book and replaced with a `// ...` just to try and bring more clarity to the point that is actually being taught in that listing.
7979
80+
When you see matching `#region HIGHLIGHT` and `#endregion HIGHLIGHT` tags within an `INCLUDE` region, this indicates that the particular code section is emphasized in the book, typically with special formatting or shading to draw attention to the key concept being demonstrated.
81+
8082
In addition, any line that ends with a `// EXCLUDE` is a line that is omitted from being seen in the book.
8183
8284
## Questions/Bugs

0 commit comments

Comments
 (0)