Typedoc包括不起作用

Question

我正在尝试使用typedoc include，所以我是这样做的。

// ./src/store/index.ts

/**
 * [[include:TypeScriptReactReduxTutorial.md]]
 */

import { combineReducers } from 'redux'

import { counterReducer } from './counter/reducer'

import { IApplicationState } from './types'

/**
 *  Whenever an action is dispatched, Redux will update each top-level application state property
 * using the reducer with the matching name. It's important that the names match exactly, and that
 * the reducer acts on the corresponding IApplicationState property type.
 */
export const rootReducer = combineReducers<IApplicationState>({
  counter: counterReducer
})

然后像这样运行typedoc

"create-docs": "typedoc --out ./doc/ ./src --externalPattern '**/node_modules/**' --ignoreCompilerErrors --includes 'mdDocs/'"

但是在文档中只添加了一个类似于这个Defined in store/rootReducer.ts:18的行，并且没有从我的标记文件中添加任何内容。我在这漏掉了什么？

Answer 1

我不确定这是否一直在起作用。这是对我有用的。

https://typedoc.org/api/

我使用的是TypeDoc 0.14.2

这是我的命令行

typedoc --out docs ./src --includes ./doc

下面是我评论的一个例子

/**
 * Process contents and returns a the processed contents.
 * <div>&nbsp;</div>
 * <strong>See:</strong> {@link BuildProcess.buildInclude}
 * @param contents The contents of the file currently being read
 * @param srcpath The source path of the file that contents were read from
 * @param destpath The destination file that the contents are to be written into.
 * @returns The contents of the file after they have been processed.
 * [[include:usercase.md]]
 */

更新1

还可以包括一个目录，然后包含子目录中的mardown文件。例如，我的doc目录包含一个名为javascript_string的目录。

typedoc --out docs ./src --includes ./doc

评论

/**
 * Process contents and returns a the processed contents.
 * <div>&nbsp;</div>
 * <strong>See:</strong> [[BuildProcess.buildInclude]]
 * @param contents The contents of the file currently being read
 * @param srcpath The source path of the file that contents were read from
 * @param destpath The destination file that the contents are to be written into.
 * @return The contents of the file after they have been processed.
 * [[include:javascript_string/usercase.md]]
 */