Angular项目中Compodoc工具忽略*.d.ts文件的解决方法咨询

遇到Compodoc无视你配置的.d.ts文件确实让人头疼，我整理了几个经过验证的解决方案，你可以逐一尝试：

1. 添加--includeDeclarations命令行参数 #

Compodoc默认会跳过声明文件，你需要显式告诉它要包含这些文件。修改你的执行命令为：

compodoc -p ./tsconfig.compodoc.json --includeDeclarations

这个参数会强制Compodoc处理所有匹配的.d.ts文件，你可以重新执行命令，观察输出是否不再忽略那些接口文件。

2. 检查并更新Compodoc版本 #

较旧的Compodoc版本可能对.d.ts文件的支持不完善，建议升级到最新稳定版：

npm install -g @compodoc/compodoc

更新完成后再重新尝试生成文档，新版本往往修复了这类兼容性问题。

3. 完善tsconfig.compodoc.json配置 #

除了include字段，确保你的配置中没有意外排除.d.ts文件，同时可以添加compilerOptions相关配置来明确声明文件的处理：

{
  "compilerOptions": {
    "declaration": true,
    "emitDeclarationOnly": false
  },
  "include": [
    "src/**/*.d.ts",
    "src/**/*.ts"
  ],
  "exclude": [
    "node_modules",
    "dist"
  ]
}

这里的declaration: true确保TypeScript正确识别声明文件，而exclude列表里不要包含你的.d.ts所在路径。

4. 清理Compodoc缓存并重新生成 #

有时候缓存会导致配置不生效，你可以先清理缓存再重新构建：

compodoc -c  # 清除缓存
compodoc -p ./tsconfig.compodoc.json --includeDeclarations  # 重新生成文档

完成这些步骤后，你的.d.ts文件应该就能被正确纳入文档生成范围了。

内容的提问来源于stack exchange，提问作者Mohammad Zatkhahi