Microsoft/TypeScript

Declaration emit of private properties should strip jsdoc

開放

#58,145 建立於 2024年4月10日

 (1 則留言) (3 個反應) (0 位負責人)TypeScript (13,395 個分叉)batch import
BugDomain: Declaration EmitHelp Wanted

倉庫指標

星標
 (108,860 顆星)
PR 合併指標
 (PR 指標待抓取)

描述

🔎 Search Terms

jsdoc dts declaration emit private properties property

🕗 Version & Regression Information

  • This is the behavior in every version I tried

⏯ Playground Link

https://www.typescriptlang.org/play?#code/KYDwDg9gTgLgBAYwDYEMDOa4DEITgbwCg4S4B6AKgrgBUALAS0ybhTjAFcAjJBhOALbAYdCABMAdHAplipTjz7tuvBAFlhosQAoAlAQC+hOSUrV6LFmzBQGANxQxggzeIA0rAHZi4AdwZISHBczmgwtmBgwD4MnnAizmLAyChQjgwQcQBmAcBSMibstg5ORfaOwBoi4nqGhAZAA

💻 Code

export class Foo {
    /** This is a public method. */
    public publicMethod() {}

    /** This is a private method, and will be stripped in the declaration file. */
    private privateMethod() {}
}

🙁 Actual behavior

export declare class Foo {
    /** This is a public method. */
    publicMethod(): void;
    /** This is a private method, and will be stripped in the declaration file. */
    private privateMethod;
}

Note the jsdoc on the private method.

🙂 Expected behavior

export declare class Foo {
    /** This is a public method. */
    publicMethod(): void;
    private privateMethod;
}

Additional information about the issue

It sure seems like this info should be stripped; after all, the type information is gone, leaving only a marker to inform child classes.

This causes TypeScript's own dts files to be filled with private method jsdoc. https://github.com/microsoft/TypeScript/pull/57492/files#r1559884318

貢獻者指南