用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;

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

当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/

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