microsoft / microsoft/vscode-cpptools

Doxygen comments to the right of members or fields do not parse if they span multiple lines

Open
#5,811 3 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Feature Request Feature: Doc comments Language Service Visual Studio
Dominant language
TypeScript
Stars
6.2k
Forks
1.7k
Avg merge
14h 46m
Merged PRs (30d)
61

Description

Type: LanguageService

Describe the bug

  • VS Code Version: 1.47.2
  • C/C++ Extension Version: 0.29.0

For struct members or class fields, I will often write a comment next to it instead of above it in order to reduce clutter. Since I use rulers, these comments very often extend across more than one line, e.g. something like

            module owner;   /** The owner of this instance. This determines e.g. which message queue
                                to listen to. */

Hovering above owner I would expect the comment to be shown, but this is not the case. It appears that this only works if the comment spans a single line instead of more than one. Multiline comments only work when the comment is above the field, not to its right.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Reproduce the reported C++ language-service behavior with the multiline trailing Doxygen comment shown in the issue, then compare it with a single-line trailing comment and a multiline comment above the field. The issue names no source file or test; done means hovering over owner displays the complete trailing comment across multiple lines.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp, vscode
Domain
devtools
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.