microsoft / microsoft/vscode-cpptools
Code blocks in Doxygen comments have a leading space
Open
Nobody has claimed this yet.
bug
Feature: Doc comments
Language Service
verified
- Dominant language
- TypeScript
- Stars
- 6.2k
- Forks
- 1.7k
- Avg merge
- 14h 46m
- Merged PRs (30d)
- 61
Description
Type: Bug
/**
* a
*
* ```c
* a
* ```
*
* @param a a
*/
void f(int a) {}
This occurs because we don't strip the single space after the star. If it wasn't there, this doesn't happen:
/**
a
```c
a
```
@param a a
*/
void f(int a) {}
Extension version: 1.32.1
VS Code version: Code 1.117.0 (10c8e557c8b9f9ed0a87f61f1c9a44bde731c409, 2026-04-21T16:12:14-07:00)
OS version: Linux x64 6.8.0-110-generic
Modes:
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the supplied C/Doxygen reproduction and trace the VS Code C/C++ extension's comment parsing or rendering path for lines beginning with a star and space. Done means fenced code inside Doxygen comments renders without the unintended leading space while the surrounding comment content remains unchanged.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- c, typescript, vscode
- Domain
- tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 52/100