TypeDoc 无法生成导入模块文档仅entryPoints内文件生效如何解决

1. 修正错误配置 #

你当前使用的includes配置不符合预期用途，该配置仅用于加载你在注释中通过[[include:filepath.md]]语法引用的外部Markdown片段，和源码扫描逻辑无关，可以直接删除该配置项。

2. 调整入口和扫描规则 #

根据你的项目结构二选一即可：

方案A：全量扫描src目录所有TS文件 #

如果你想要生成src下所有TS文件的文档，修改typedoc.json如下：

{
  "entryPoints": ["src/**/*.ts"],
  "entryPointStrategy": "expand",
  "out": "docs"
}

entryPointStrategy设为expand时，TypeDoc会自动展开你entryPoints里写的通配符路径，扫描所有匹配的TS文件作为文档入口。

方案B：仅保留单个入口，导出所有需要生成文档的成员 #

如果你坚持只用src/app.ts作为唯一入口，需要确认两个条件：

• 所有其他文件中需要生成文档的成员，都被显式export导出
• 入口文件src/app.ts中，对这些成员做了显式的导出操作，而不是只做了内部导入使用。举个例子，如果要导出src/utils.ts里的所有成员，入口文件要写export * from './utils.ts'，仅写import './utils.ts'或者import { xxx } from './utils.ts'后仅内部调用，TypeDoc会认为这些成员是内部私有实现，不会生成单独的文档。

3. 可选配置排查 #

如果还是有部分成员没有生成，检查是否存在以下配置过滤规则：

• 确认没有开启excludePrivate、excludeProtected、excludeInternal配置过滤了你要生成的成员
• 确认所有要生成文档的成员都加了合法的TSDoc注释，开启excludeNotDocumented配置时，无注释的成员会被直接过滤

内容的提问来源于stack exchange，提问作者Sardorkhuja Tukhtakhodjaev