Skip to content

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

Closed

Description

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.

Activity

  1. added this to the On Deck milestone on Jun 13, 2023
  2. moved this to In progress in cpptoolson Jan 2, 2025
  3. moved this from In progress to Pull Request in cpptoolson Jan 2, 2025
  4. moved this from Pull Request to Done in cpptoolson Jan 2, 2025
  5. added
    fixedCheck the Milestone for the release in which the fix is or will be available.
    on Jan 2, 2025
  6. v-ericawu commented on Jan 26, 2025

    @v-ericawu

    Verified on C/C++ 1.23.4(pre-release), this issue has been fixed:
    Image

  7. locked and limited conversation to collaborators on Feb 25, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Feature: Doc commentsAn issue related to code comments shown in hover, completion, and signature help.Language ServicebugfixedCheck the Milestone for the release in which the fix is or will be available.

    Type

    Projects

    • Status
      Done

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions