Doc comments for a param on the same line as the function name show as a comment for the function itself

Open
#14,033 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

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

Research direction

Reproduce the issue with the provided C++ declaration using version 1.29.0, then trace how inline parameter comments are associated with the function. Compare the behavior with the regression discussed in issue 13725; done means “first param” and “second param” appear on their parameters while “computes the sum” remains on sum.

Written by the indexing model from the issue text.

Description

bug Feature: Doc comments insiders Language Service

Repros with 1.29.0 with

class Afterdoc_Test
{
    void sum(int one, // first param,
        int two // second param
    ); // computes the sum
};

Doc comment shows "first param" for the comment of sum.

Regression for the 2nd bug fix of https://github.com/microsoft/vscode-cpptools/issues/13725 . However, that bug seems higher priority than this bug, which is why we haven't reverted that fix.

Dominant language
TypeScript
Stars
6.2k
Forks
1.7k
Avg merge
14h 46m
Merged PRs (30d)
61

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.

More from microsoft/vscode-cpptools

All issues in microsoft/vscode-cpptools

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.