user0/rust
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update syntax tree viewer docs

Browse source
This commit is contained in:
Mark Murphy 2025-01-16 17:37:10 -05:00
parent 99c7013070
commit 2406225266
1 changed files with 9 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

16
src/tools/rust-analyzer/docs/dev/README.md
View file

@ -154,19 +154,21 @@ There are also several VS Code commands which might be of interest:
* `rust-analyzer: Status` shows some memory-usage statistics.
* `rust-analyzer: Syntax Tree` shows syntax tree of the current file/selection.
* `rust-analyzer: View Hir` shows the HIR expressions within the function containing the cursor.
You can hover over syntax nodes in the opened text file to see the appropriate
rust code that it refers to and the rust editor will also highlight the proper
text range.
* If `rust-analyzer.showSyntaxTree` is enabled in settings, `Rust Syntax Tree: Focus on Rust Syntax Tree View` shows the syntax tree of the current file.
You can click on nodes in the rust editor to go to the corresponding syntax node.
You can click on `Reveal Syntax Element` next to a syntax node to go to the corresponding rust code and highlight the proper text range.
If you trigger Go to Definition in the inspected Rust source file,
the syntax tree read-only editor should scroll to and select the
the syntax tree view should scroll to and select the
appropriate syntax node token.
![demo](https://user-images.githubusercontent.com/36276403/78225773-6636a480-74d3-11ea-9d9f-1c9d42da03b0.png)
You can click on `Copy` next to a syntax node to copy a text representation of the node.
![demo](https://github.com/user-attachments/assets/2d20ae87-0abf-495f-bee8-54aa2494a00d)
## Profiling