microsoft / microsoft/TypeScript

Allow folding of JSDoc comments

Abierto
#35,611 6 comentarios 1 reacción 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Domain: LS: Outlining Effort: Moderate Help Wanted Suggestion
Lenguaje dominante
Go
Estrellas
111k
Forks
14.4k
Merge medio
1 d 19 h
PR fusionados (30 d)
117

Descripción

VsCode version: 1.40.2 (Oct 2019, 2)
OS: Windows 10 v1709 os build 16299.847
TypeScript Version: 3.6.3

Search Terms: vs code fold "app.get" outlining jsdoc comment expressjs folding

Code


/**
 * @api {get} /ProjectsList/:projectId/ Get project
 *
 * @apiDescription Get a project by projectId.
 *
 * @apiName Get User Projects
 * @apiGroup Project
 * @apiVersion 1.0.0
 *
 */
app.get('/:retailUnit/:language/ProjectsList/:projectId/', retailUnit, (req, res) => {
    const projectListController = new ProjectListController();

  });

Repro:

  • Create file foobar.js, copy paste the code from above.
  • Try fold all.
    Expected behavior: Comment and method fold
    Actual behavior: method fold, comment does not

Expected behavior: I can fold the jsdoc comment above the app.get function

Actual behavior: I cannot fold the jsdoc comment, outlining not available.

Related Issues: Some (incorrectly?) for vs code, but these are the ones I found, but the first one is very similar to this one, but for arrow functions instead:

This is my first report here, I hope it is ok. :-)

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 problema en foobar.js usando el JSDoc y el ejemplo de app.get proporcionados, y luego rastrea el comportamiento del esquema de TypeScript/VS Code. Se considera terminado cuando Fold All y el control de plegado del comentario incluyen el bloque JSDoc; el informe no menciona ningún archivo fuente ni ninguna prueba específicos.

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

Evaluación

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

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.