microsoft / microsoft/TypeScript

Allow folding of JSDoc comments

Offen
#35,611 6 Kommentare 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Domain: LS: Outlining Effort: Moderate Help Wanted Suggestion
Vorherrschende Sprache
Go
Sterne
111k
Forks
14.4k
Ø Merge
1 T. 19 Std.
Gemergte PRs (30 T.)
117

Beschreibung

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. :-)

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Reproduziere das Problem in foobar.js anhand der bereitgestellten JSDoc und des app.get-Beispiels und verfolge anschließend das Gliederungsverhalten von TypeScript/VS Code. Als erledigt gilt die Aufgabe, wenn Fold All und die Faltsteuerung des Kommentars den JSDoc-Block einschließen; im Bericht wird keine bestimmte Quelldatei oder kein bestimmter Test genannt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
javascript, typescript, vscode
Bereich
tooling
Issue-Typ
Feature
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
30/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.