microsoft / microsoft/vscode-cpptools
Showing the documentation for virtual methods through inheritance.
Open
Nobody has claimed this yet.
Feature Request
Feature: Doc comments
Language Service
- Dominant language
- TypeScript
- Stars
- 6.2k
- Forks
- 1.7k
- Avg merge
- 14h 46m
- Merged PRs (30d)
- 61
Description
Hello,
I usually document the interface like:
/**
* @breaf foo should do THE thing.
virtual void foo() = 0;
Documenting the override-ed method is often redundant so I don't do it much.
It would be nice if the hover would show the interface's documentation for the overridden method (if it is not provided for it of course).
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 locating the C++ hover handling and any tests for documentation on overridden methods. Trace how documentation is selected for an override and its base virtual method. Done means a hover on an undocumented override displays the inherited interface documentation, while an override's own documentation remains preferred.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp, typescript
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100