Clarify and expand documentation for runtime ParseTreeWalker #2782
Conversation
This file contains 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
|
|
||
| /// <summary> | ||
| /// Performs a walk on the given parse tree starting at the root and going down recursively | ||
| /// with depth-first search. On each node, <seealso cref="ParseTreeWalker#enterRule"/> is called before |
There was a problem hiding this comment.
why not use block comments?
There was a problem hiding this comment.
ill change this into blocks
| /// with depth-first search. On each node, | ||
| /// <see cref="ParseTreeWalker.EnterRule(IParseTreeListener, IRuleNode)"/> is called before | ||
| /// recursively walking down into child nodes, then | ||
| /// <see cref="ParseTreeWalker.ExitRule(IParseTreeListener, IRuleNode)"/> |
There was a problem hiding this comment.
why not use block comments?
There was a problem hiding this comment.
/// line comments are the de-facto standard for C# code. Java-style /** */ are technically allowed, but nearly non-existent in the wild.
There was a problem hiding this comment.
microsoft uses triple slashes on their c# documentation so I thought of doing the same
|
thanks song yang |
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.
My pull request based on the issue #2759 and the answer given by @ericvergnaud . I applied the changes to all target languages. Hopefully, the documentation style conforms to all the target languages and is accepted by each respective compiler.