使用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/

有关详细信息，请参阅文档 。