Hacktoberfest 2026: die Issues, die Maintainer für den Oktober markiert haben – offen und einsteigerfreundlich. Hacktoberfest-Issues durchsuchen

[api-documenter] Annotations on type alias parameters are ignored

Offen
  • Stimmt etwas nicht?
#5,447 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Anfängerfreundlichkeit
45/100
Issue-Typ
Bug
Klarheit
Größtenteils klar
Aktivitätsstatus
Veraltet
Tech-Stack
typescript
Bereich
documentation

Rechercherichtung

Start by reproducing the issue in @microsoft/api-documenter with the TypeScript type alias shown in the report and inspect the generated Markdown output. Trace how the alias and its parameter comments are processed. Done means the generated documentation displays the description for bar while preserving the alias description and signature.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

Summary

Annotating a type alias as a whole works fine, but individual paramaters are ignored.

Repro steps

Consider the following:

/**
 * This is a type alias.
 *
 * @public
 */
type Foo = {
    /**
     * This is a parameter.
     */
    bar?: unknown;
};
Expected result

For the parameter bar to have its description displayed in the generated markdown file.

Actual result

Generated markdown file:

Foo type

This is a type alias.

Signature:

type Foo = {
    bar?: unknown;
};

Standard questions

Please answer these questions to help us investigate your issue more quickly:

Question Answer
@microsoft/api-documenter version? 7.27.4
Operating system? Windows
Documentation target? Markdown
Would you consider contributing a PR? Yes
TypeScript compiler version? 5.8.2
Node.js version (node -v)? 24.11.0
Vorherrschende Sprache
TypeScript
Sterne
6.5k
Forks
708
Ø Merge
2 T. 1 Std.
Gemergte PRs (30 T.)
46

Entwicklungsumgebung

Die Einrichtungsdateien dieses Projekts haben wir noch nicht geprüft. Beginnen Sie mit der README; die allgemeinen Schritte stehen in unserem Leitfaden für den ersten Beitrag.

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus microsoft/rushstack

Alle Issues in microsoft/rushstack

Ähnliche Issues

Weitere Issues zu TypeScript

Neue Issues direkt in Ihr Postfach

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