microsoft / microsoft/TypeScript
Add JSDOC @module support for intellisense.
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
Intellisense jsdoc support for modules
Suggestion
When adding /** @module moduleName Module Description. */ to a module, then doing this:
import * as myName from "./moduleName";
I think it makes sense, when importing the whole namespace, to include the jsdoc @module comment.
I also think that when pressing Ctrl+Space for code completion on "./" (to get a list of modules) should also show the module documentation.
Use Cases
Better support for module documentation. I'm developing some module libraries and it would be great to give end users a good experience with better intellisense documentation.
Examples
aModule.ts
`/** @module aModule Does something awesome. */`
app.ts
import * as aModule from "./aModule";
// (moduleName should both have the doc details)
// ("./{*.*}" - all files in code completion should show the documentation as well)
Checklist
My suggestion meets these guidelines:
- This wouldn't be a breaking change in existing TypeScript/JavaScript code
- This wouldn't change the runtime behavior of existing JavaScript code
- This could be implemented without emitting different JS based on the types of the expressions
- This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, etc.)
- This feature would agree with the rest of TypeScript's Design Goals.
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
Reproduce los ejemplos de aModule.ts y app.ts; después, inspecciona el JSDoc existente y el comportamiento de completado de módulos para las importaciones de espacios de nombres y las completaciones de "./". Se considera terminado cuando la documentación @module aparece para el espacio de nombres importado y junto a las sugerencias de módulos, sin cambiar la salida en tiempo de ejecución.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- javascript, typescript
- Área
- developer-experience, tooling
- Tipo de issue
- Nueva funcionalidad
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 35/100