Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Parameter hint interprets * in a comment as markdown while hover interprets it as text #11082

Closed
michelleangela opened this issue Jun 13, 2023 · 0 comments
Labels
bug Feature: Doc comments An issue related to code comments shown in hover, completion, and signature help. fixed Check the Milestone for the release in which the fix is or will be available. Language Service
Milestone

Comments

@michelleangela
Copy link
Contributor

Code sample:

//HELLO!!! This is comment for function some_function *test*
void my_function(int var1, int var2, int var3)
{
}


int main()
{
    my_function(1, 2, 3);
}

Repro steps:

  1. Use code sample.
  2. Invoke parameter hint comments by doing autocomplete for the parameters in my_function(int var1, int var2, int var3).

Actual result:
The * in the comment is interpreted as markdown.
image

Note: when doing a hover over the function, the * is interpreted as text.
image

Expected behavior for current design is the displayed comments should be consistent. When the markdown support is done, this behavior may change.

@michelleangela michelleangela added bug Language Service Feature: Doc comments An issue related to code comments shown in hover, completion, and signature help. labels Jun 13, 2023
@bobbrow bobbrow added this to the On Deck milestone Jun 13, 2023
@bobbrow bobbrow moved this to In progress in cpptools Jan 2, 2025
@bobbrow bobbrow moved this from In progress to Pull Request in cpptools Jan 2, 2025
@sean-mcmanus sean-mcmanus modified the milestones: On Deck, 1.23.3 Jan 2, 2025
@sean-mcmanus sean-mcmanus moved this from Pull Request to Done in cpptools Jan 2, 2025
@sean-mcmanus sean-mcmanus added the fixed Check the Milestone for the release in which the fix is or will be available. label Jan 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Feature: Doc comments An issue related to code comments shown in hover, completion, and signature help. fixed Check the Milestone for the release in which the fix is or will be available. Language Service
Projects
Status: Done
Development

No branches or pull requests

3 participants