microsoft / microsoft/vscode-cpptools
Doc comment on hover missing or for incorrect member
Open
Nobody has claimed this yet.
bug
Feature: Doc comments
Language Service
- Dominant language
- TypeScript
- Stars
- 6.2k
- Forks
- 1.7k
- Avg merge
- 14h 46m
- Merged PRs (30d)
- 61
Description
In the following code example, if I hover over type, I get the correct doc comment. If I hover over type2, I get the correct doc comment on Windows, but on Linux I get nothing. If I hover over type3, it displays the doc comment for the class instead of the member. This does not appear to repro in VS.
#include <vector>
// CLASS DOC
template <class T>
class test
{
public:
// MEMBER DOC
typename T type;
// Works
// MEMBER2 DOC
typename int type2;
// Works on Windows, but nothing on Linux
// MEMBER3 DOC
typedef std::vector<T> type3;
// Shows CLASS DOC
};
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
Start by running the supplied C++ hover repro on Linux and Windows in VS Code, checking type, type2, and type3 against their comments. Investigate the extension's hover handling for template members; done means each member shows its own documentation consistently on both platforms.
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
- 42/100