microsoft / microsoft/vscode-cpptools
Process XML comments in documentation comments
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 6.2k
- Forks
- 1.7k
- Avg merge
- 14h 46m
- Merged PRs (30d)
- 61
Description
As I said in my previous post, all comments would be supported, but only the XML tags will be recognized specially, unless we decide to add additional parsing of the comments.
Hi,
if I'm correct the doc comment support is now on the main branch. However I do not seem to be able to get the XML tag recognized. I followed the guidelines from this page but when I hover on the function I documented using the
Did I misunderstand how XML tags are supposed to be parsed or am I missing something?
Originally posted by @zupalex in https://github.com/Microsoft/vscode-cpptools/issues/399#issuecomment-457513013
The issue tracking doxygen comments is https://github.com/Microsoft/vscode-cpptools/issues/658 .
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 comparing the reported hover output with the XML documentation guidance linked in the issue and review the related issues #399 and #658. Confirm whether
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp, typescript, vscode
- Domain
- developer-experience, documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100