Use /** comments to show it on IDEs
Open
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 121
- Forks
- 15
- Avg merge
- 17h 22m
- Merged PRs (30d)
- 3
Description
The declaration file is using basic multi line /* comments, by using /** IDE like VSCode will show it.
Contributor guide
No contributing guide indexed for this repository
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
Locate the declaration file and inspect its existing multi-line comments. Change the relevant comments to the /** form, then open the declarations in VSCode to verify that the text is shown by the IDE.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, vscode
- Domain
- developer-experience, documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100