Документирование внешних типов с помощью TypeDoc

У меня есть два файла, файл A и файл B. Файл A использует класс из файла B. Моя цель - сослаться на вывод TypeDoc для класса, используемого в файле B, в выводе TypeDoc для файла A. Кажется, я не могу этого сделать это.

Я знаю, что вы можете ссылаться на символ, содержащийся в том же файле, с помощью TypeDoc в двойных скобках, например [[Foo]], но это не сработало для внешнего типа, подобного этому.

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

// More code...

Возможно ли это достичь?

ОТВЕТЫ

Ответ 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/

Для получения дополнительной информации см. документацию.