使用TypeDoc记录外部类型

Question

我有两个文件，文件A和文件B。文件A使用文件B中的类。我的目标是在文件A的TypeDoc输出中引用文件B中使用的类的TypeDoc输出。这个。

我知道您可以使用带有双括号的TypeDoc来引用包含在同一文件中的符号，例如[[Foo]]，但这不适用于像这样的外部类型。

/** Trying to reference [[FileB.InnerClass]] like this doesn't work. */
// This here is what I want to include
export type InnerClass = FileB.InnerClass;

// More code...

这有可能实现吗？

Answer 1

是的，有可能。

1. 更正评论。
2. 您不必输入文件名，但必须使用以下命令从文件中导入对象 import

import { InnerClass } from './FileB';

/**
 * See the [[InnerClass]] for more details.
 */
export type innerClass = InnerClass;

3. 要生成文档，请运行以下命令。

typedef全局时，请使用以下命令：

typedoc --out ./docs --target ES6 ./src/

或本地时：

npx typedoc --out ./docs --target ES6 ./src/

• ./docs 是用于生成文档的文件夹。

• ./src/ 是您的代码所在的文件夹。

• --target ES6 版本的JavaScript。

如果只想显示没有不同模块的类，请使用以下标志--mode file：

npx typedoc --out ./docs --mode file --target ES6 ./src/

有关更多信息，请参见文档。