microsoft / microsoft/vscode-cpptools
Code blocks in Doxygen comments don't format properly when not before a tag
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
/**
* ```c
* a
* ```
*/
void f(int 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
Reproduce the formatting issue with the two C/Doxygen comment snippets in the issue, comparing a code block before and after the @param tag. Trace the VS Code C/C++ extension's Doxygen comment formatting entry point. Done means both examples render their code blocks correctly, regardless of tag placement.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- c, typescript, vscode
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100