microsoft / microsoft/TypeScript

Implemented method JSDocs not behaving correctly for @param

Abierto
#38,643 1 comentario 2 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Bug Domain: JSDoc
Lenguaje dominante
Go
Estrellas
111k
Forks
14.3k
Merge medio
2 d 4 h
PR fusionados (30 d)
132

Descripción

TS Template added by @mjbvz

TypeScript Version: 4.0.0-dev.20200518

Search Terms

  • completionEntryDetails
  • jsdoc
  • tags

  • VSCode Version: 1.45.0
  • OS Version: Ubuntu 20.04

Steps to Reproduce:

  1. Add JSDocs to an interface, and implement that interface in a class
interface Sample {
  /** 
   * Does some important work
   * @param name Name of employee working
   * @param age Age of employee
   */
  doWork(name: string, age: number): void;
}

let s: Sample;


class Concrete implements Sample {
  doWork(name: string, age: number) {
    // Nothing to do
  }
}

let c: Concrete;
  1. Attempt to access intellisense for the class, and notice the @param information has not been picked up from the interface.

travetto-1589679889262

Does this issue occur when all extensions are disabled?: Yes

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

Reproduce el ejemplo de la interfaz y la clase que la implementa, y luego inspecciona la ruta completionEntryDetails que IntelliSense utiliza para el método de la clase. Compara la documentación de los parámetros que se muestra para la interfaz con la que se muestra para la implementación. Se considera terminado cuando las sugerencias de completado de la implementación incluyen las descripciones @param de la interfaz, con cobertura para el ejemplo indicado.

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

Evaluación

Stack tecnológico
typescript
Área
compilers
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.