[ExpressionLanguage] Add comment support to expression language #54978
+76
−0
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.
When expression language expressions are provided by the user, it would be really helpful if we could include comments in the expression. Many times the user will write something like
which in my opinion, would be much better with a comment
so that the next person reading the expression knows what the magical 123 is.
The implementation is quite simple, given it's ok to strip the comments from AST & the compiled version.
Why
/*
&*/
This seems to be the most common way among different programming languages, including JS, C#, Go, C, PHP, Java, Rust – also in business scenarios you often times want multi-line comments, for which this syntax usually stands for. Also, this makes it possible to use comments in the middle of single-line expressions.
At the moment, unlike multi-line comments in PHP, we always require closing
*/
.