Preserve the jsdoc comments for interface while compiling.

Suggestion

🔍 Search Terms

tsc jsdoc

✅ Viability Checklist

My suggestion meets these guidelines:

• ✅ This wouldn't be a breaking change in existing TypeScript/JavaScript code
• ✅ This wouldn't change the runtime behavior of existing JavaScript code
• ✅ This could be implemented without emitting different JS based on the types of the expressions
• ✅ This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, new syntax sugar for JS, etc.)
• ✅ This feature would agree with the rest of TypeScript's Design Goals.

⭐ Suggestion

Add a configuraion for preserving the jsdoc comments for interface while compiling.

📃 Motivating Example

Example

My .ts file like this:

// test.ts
/**
 * @typedef {Object} ITest - For test
 * @property {string} a
 */
export interface ITest {
  a: string
}

/**
 * @function print - print ITest
 * @params {ITest} d
 */
export function print (d: ITest): void {
  console.log(d.a)
}

while tsc compiling, the .js like this:

// test.js
/**
 * @typedef {Object} ITest - For test
 * @property {string} a
 */
/**
 * @function print - print ITest
 * @params {ITest} d
 */
export function print(d) {
    console.log(d.a);
}

💻 Use Cases

There are two case as I can see.

• Preverse comments for files.
• Use jsdoc comments to mark interfaces or types on .ts and generate doc through jsdoc comments on .js

Bắt đầu bằng cách chạy tsc trên ví dụ test.ts được cung cấp và so sánh test.js được tạo ra với đầu ra được yêu cầu. Xác định hành vi cấu hình và xác minh rằng các nhận xét JSDoc của interface và type được giữ nguyên mà không thay đổi đầu ra khi chạy.