microsoft / microsoft/TypeScript
Support auto-completion for TSDoc
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Go
- Estrellas
- 111k
- Forks
- 14.3k
- Merge medio
- 2 d 4 h
- PR fusionados (30 d)
- 132
Descripción
### 🔍 Search Terms
tsdoc complete
### ✅ Viability Checklist
- [x] This wouldn't be a breaking change in existing TypeScript/JavaScript code
- [x] This wouldn't change the runtime behavior of existing JavaScript code
- [x] This could be implemented without emitting different JS based on the types of the expressions
- [x] This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, new syntax sugar for JS, etc.)
- [x] This isn't a request to add a new utility type: https://github.com/microsoft/TypeScript/wiki/No-New-Utility-Types
- [x] This feature would agree with the rest of our Design Goals: https://github.com/Microsoft/TypeScript/wiki/TypeScript-Design-Goals
### ⭐ Suggestion
TypeScript currently only supports auto-completion for JSDoc, not TSDoc. For example, there is no intelligent suggestion for [@defaultValue](https://tsdoc.org/pages/tags/defaultvalue/).

### 📃 Motivating Example
If [TSDoc](https://tsdoc.org/) is the recommended commenting standard for TypeScript, then it should natively support intelligent suggestions and syntax highlighting for TSDoc.
### 💻 Use Cases
Writing comments using TSDoc syntax in VSCode.
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Comienza investigando cómo TypeScript proporciona actualmente la autocompletación de JSDoc y cómo VSCode consume esos resultados del servicio de lenguaje. Compara ese comportamiento con etiquetas de TSDoc como @defaultValue y determina el comportamiento esperado del resaltado de sintaxis y la autocompletación; se considera completado cuando los comentarios de TSDoc reciben sugerencias inteligentes sin cambiar el JavaScript emitido.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- typescript
- Área
- developer-experience, tooling
- Tipo de issue
- Nueva funcionalidad
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 35/100