Add debug emit docs #12411
Merged
Add debug emit docs #12411
Conversation
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
cartermp
reviewed
Nov 16, 2021
|
|
||
| Breakpoints have two existences which must give matching behavior: | ||
|
|
||
| * At design-time, before debugging is launched, `ValidateBreakpointLocation` is called to validate every breakpoint. This operators on the SyntaxTree and forms a kind of "gold-standard" about the exact places where break points are valid. |
There was a problem hiding this comment.
Suggested change
| * At design-time, before debugging is launched, `ValidateBreakpointLocation` is called to validate every breakpoint. This operators on the SyntaxTree and forms a kind of "gold-standard" about the exact places where break points are valid. | |
| * At design-time, when you set a breakpoint (either via clicking in the editor or a key binding), the IDE will call the language service, which will in turn call `ValidateBreakpointLocation`. This routine attempts to find the best match for a construct relative to where you set the breakpoint, and also asserts that there is a matching sequence point for the range of that construct. If there is no match, or there is a construct considered "invalid" by this routine, a breakpoint will not be set. |
KevinRansom
approved these changes
Nov 17, 2021
# for free
to join this conversation on GitHub.
Already have an account?
# 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.
This adds detailed docs about the whole topic of "Debug emit", trying to capture as much detail about what and how we do when emitting debug code.
@brettfo @KevinRansom @jonsequitur @vzarytovskii @TIHan @cartermp Please give this a careful read end-to-end - a passing knowledge of this area is pretty much essential