Some characters rendered incorrectly in Markdown comments when inline/block code is used

[bshoshany]

Environment

• OS and Version: Windows 11 v22621.2134
• VS Code Version: 1.81.1
• C/C++ Extension Version: 1.17.2

Bug Summary and Steps to Reproduce

Bug Summary:

Thanks for adding this feature following issue #6020! It is very useful, but there are a few kinks to iron out.

1. Some characters such as <, >, and _ within inline code or fenced code blocks in Markdown comments are incorrectly rendered with an escape character in front, e.g. \<, \>, and \_.
2. Indentation is not preserved in fenced code blocks, hindering readability.

Steps to reproduce:

Create the following sample program:

#include <iostream>
#include <vector>

// This function returns an `std::vector<size_t>` with `n` elements initialized to consecutive values.
//
// Usage example:
// ```
// std::vector<size_t> vec;
// vec = test();
// ```
std::vector<size_t> test(const size_t n)
{
    std::vector<size_t> temp(32);
    for (size_t i = 0; i < n; ++i)
        temp[i] = i;
    return temp;
}

int main()
{
    std::vector<size_t> vec = test(32);
    for (const size_t k : vec)
        std::cout << k << ' ';
}

Expected behavior: The Markdown comment should be rendered correctly.

Actual behavior: See screenshot.

Configuration and Logs

I don't think any of these are relevant since the problem is just with Markdown rendering and not actual code, but I can attach them later if needed.

Other Extensions

No response

Additional context

No response

[bobbrow]

Thanks for reporting this. We'll get it fixed.

[bshoshany]

Great, thank you! :)

[bobbrow]

The fix for this is available in 1.17.5

[bshoshany]

Awesome, thanks! However, the indentation in fenced code blocks still doesn't show correctly. My apologies, this is totally my fault - the code I put in my original comment isn't the right code. It doesn't match the screenshot and doesn't properly demonstrate the issue. I fixed it now.

In 1.17.5 the first problem I mentioned (some characters are rendered with a redundant escape character) is fixed, but the fenced code blocks are still not correctly indented - see screenshot:

The for loop should be indented for readability, but it is not. Would it be possible to fix this? Thanks again.

[bobbrow]

@browntarik does our comment parser eat all the leading whitespace? If so, we should open a new bug to tell it to stop eating whitespace between backticks so that the VS Code markdown renderer can do the right thing. If not, then we need to forward this bug on to the VS Code team.

[sean-mcmanus]

I think it's our comment processing code since TypeScript doesn't repro the issue. Would the new bug be for 1.18.0 or 1.17.6?

[bobbrow]

1.18.0

[bobbrow]

This is tracked by #11379 now