microsoft / microsoft/vscode-cpptools
Doc comments for a param on the same line as the function name show as a comment for the function itself
Open
Nobody has claimed this yet.
bug
Feature: Doc comments
insiders
Language Service
- Dominant language
- TypeScript
- Stars
- 6.2k
- Forks
- 1.7k
- Avg merge
- 14h 46m
- Merged PRs (30d)
- 61
Description
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.
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 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.
Assessment
- Tech stack
- cpp, typescript
- Domain
- tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100