microsoft / microsoft/vscode-cpptools

Process XML comments in documentation comments

Abierto
#3,097 10 comentarios 29 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Feature Request Feature: Doc comments Language Service
Lenguaje dominante
TypeScript
Estrellas
6.2k
Forks
1.7k
Merge medio
14 h 46 min
PR fusionados (30 d)
61

Descripción

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

tag, It displays everything as plain text, including the XML tags.

vscode_doc

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 .

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Comienza comparando la salida reportada al pasar el cursor con la guía de documentación XML enlazada en el issue y revisa los issues relacionados #399 y #658. Confirma si las etiquetas

en los comentarios de documentación de C++ deben mostrarse como documentación con formato; se considera terminado cuando las etiquetas se reconocen en lugar de mostrarse como texto sin formato.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
cpp, typescript, vscode
Área
developer-experience, documentation
Tipo de issue
Error
Dificultad
3/5
Tiempo estimado
1-2 días
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
35/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.