allow inline intellisense comment on es6 export

Search Terms

intellisense export

Suggestion

allow inline intellisense documentation of es6 export, or at least propagate the intellisense comments of the exported package. currently nothing is exported (other than type definitions)

Use Cases

allows for index files for large libraries to have better descriptions of the sub-modules it contains.

current (working) approach is to use the old pre-es6 /** comment */export import x = requires("x")

Examples

/** promise fs based api and related quality-of-life helper functions */
import * as fs from "./fs";
export { fs };

the above intellisense comment doesn't propagate.

Checklist

My suggestion meets these guidelines:

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

まず、ES6 の export 宣言における JSDoc または IntelliSense コメントを処理している TypeScript コンパイラーの箇所を特定し、次に提示された export { fs } の例と比較します。完了条件は、生成される JavaScript を変更することなく、インラインの説明がエクスポートされたパッケージまたはモジュールに伝播されることです。