如何为TypeScript中重新导出的命名空间添加JSDoc文档？

你可以通过以下几种无需额外变量的方法实现需求：

方法一：直接注释export * as语句（TypeScript 4.5+） #

如果你的TypeScript版本在4.5及以上，直接在导出语句上方添加JSDoc注释即可，VS Code的IntelliSense会正确识别：

/**
 * 这里是Foo命名空间的描述文本
 * 包含来自bar模块的所有导出内容
 */
export * as Foo from "bar";

如果VS Code没生效，检查是否使用了项目本地的TypeScript版本（而非VS Code内置的旧版本）：可以通过右下角的TS版本号切换。

方法二：结合@namespace标签注释导出的命名空间 #

如果你的TS版本较低，或者第一种方法不生效，可以先导入再导出，同时给导出的命名空间添加@namespace标签：

import * as Foo from "bar";
/**
 * blah blah blah
 * @namespace
 */
export { Foo };

这个标签会明确告诉IDE这是一个命名空间，从而正确显示注释内容。

为什么之前的写法不生效？ #

• 直接注释export * as在旧版TypeScript中不被支持，升级到4.5+即可解决。
• 单纯的JSDoc注释没有@namespace标签时，IDE可能无法识别导出的是命名空间类型，导致注释不显示。

内容的提问来源于stack exchange，提问作者Adam Simon