Typescript Typedoc不包括';行不通

Typescript Typedoc不包括';行不通,typescript,typedoc,Typescript,Typedoc,我正在尝试使用typedocinclude,下面是我如何做到这一点的 // ./src/store/index.ts /** * [[include:TypeScriptReactReduxTutorial.md]] */ import { combineReducers } from 'redux' import { counterReducer } from './counter/reducer' import { IApplicationState } from './type

我正在尝试使用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
})
/./src/store/index.ts
/**
*[[包括:TypeScriptReactReduxTutorial.md]]
*/
从“redux”导入{combinereducer}
从“./counter/reducer”导入{counterReducer}
从“./types”导入{IAApplicationState}
/**
*每当调度操作时,Redux都会更新每个顶级应用程序状态属性
*使用具有匹配名称的减速器。重要的是名字要完全匹配,而且
*减速器作用于相应的IApplicationState属性类型。
*/
export const rootReducer=combinereducer({
计数器:计数器减速机
})
然后像这样运行typedoc

“创建文档”:“typedoc--out./doc//src--externalPattern'**/node\u modules/**'--ignorecompilerrors--includes'mdDocs/”


但是在文档中,只添加了一行类似于store/rootReducer.ts:18中定义的
,并且我的标记文件中没有任何内容。我在这里遗漏了什么?

我不确定这是否一直有效。 这对我有用

我使用的是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]]
 */
评论

/**
 * 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]]
 */
/**
*处理内容并返回处理后的内容。
*  
*请参阅:[[BuildProcess.buildInclude]]
*@param contents当前正在读取的文件的内容
*@param srcpath读取内容的文件的源路径
*@param destpath要写入内容的目标文件。
*@处理完文件后返回文件内容。
*[[include:javascript\u string/usercase.md]]
*/

如果这个问题还没有解决,您是否尝试过用。/doc/和。/src的方式在命令中去掉mdDocs/的单引号?我使用的是json文件而不是命令行参数,但在我的文件中,我需要指定--includes文件夹,就像指定--out文件夹一样。至少在文件模式下,TypeDoc通过对象(或枚举、函数等)而不是文件来解析和创建页面。因此,它实际上没有任何地方可以单独发表评论。我找不到好的文档来说明这在模块模式下是否正确,因为您的默认设置是在模块模式下。更正:这似乎没有什么区别,注释本身不会出现在生成的文档中mode=modules或mode=file的任何地方
/**
 * 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]]
 */