microsoft / microsoft/vscode-cpptools
Process XML comments in documentation comments
Personne n'a encore pris cette issue.
- Langage dominant
- TypeScript
- Étoiles
- 6.2k
- Forks
- 1.7k
- Merge moyen
- 14 h 46 min
- PR mergées (30 j)
- 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 .
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Commencez par comparer la sortie au survol signalée avec les indications sur la documentation XML liées dans l’issue et examinez les issues associées #399 et #658. Confirmez si les balises
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- cpp, typescript, vscode
- Domaine
- developer-experience, documentation
- Type d'issue
- Bug
- Difficulté
- 3/5
- Temps estimé
- 1-2 jours
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 35/100