microsoft / microsoft/TypeScript

Feature Request: Split out JsDoc comments for constructor function when convert function to ES2015 class

Abierto
#32,492 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Awaiting More Feedback Domain: LS: Refactorings Suggestion
Lenguaje dominante
Go
Estrellas
111k
Forks
14.4k
Merge medio
1 d 19 h
PR fusionados (30 d)
117

Descripción

Add ability to convert JsDoc comments in following situation:

/**
 * @class
 * Some constructor description.
 * @classdesc
 * Some class description
 */
function Class() {}

must be converted to

/**
 * Some class description
 */
class Class {
  /**
   * Some constructor description.
   */
  constructor() {}
}

Right now you get following result:

/**
 * @class
 * Some constructor description.
 * @classdesc
 * Some class description
 */
class Class {
  constructor() {}
}

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

No se indica ningún archivo, prueba ni punto de entrada. Empieza localizando la conversión de funciones a clases ES2015 y el tratamiento de JsDoc; el trabajo estará terminado cuando @classdesc se convierta en el comentario de la clase, mientras que la descripción del constructor se convierta en el comentario del constructor, como se muestra en los ejemplos.

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

Evaluación

Stack tecnológico
javascript, typescript
Área
compilers
Tipo de issue
Nueva funcionalidad
Dificultad
3/5
Tiempo estimado
1-2 días
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
45/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.