microsoft / microsoft/vscode-cpptools

Documentation comments stop working when / is removed from */ and then added back

Open
#13,736 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

bug Feature: Doc comments Works in VS
Dominant language
TypeScript
Stars
6.2k
Forks
1.7k
Avg merge
14h 46m
Merged PRs (30d)
61

Description

Start with

/* a */
int foo;

Then delete the end / and then add it back, the move the cursor to the line before the command and hover over "foo".

Bug: The documentation comment stops appearing.

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 issue in the Microsoft C/C++ extension using the documented /* a */ and int foo; snippet. Remove and restore the final slash, then move the cursor to the preceding line and hover over foo; done means the documentation comment still appears after the edit.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
devtools
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.