使用 compodoc 的 Angular 项目文档答案

【问题标题】：Documentation of angular project using compodoc使用 compodoc 的 Angular 项目文档
【发布时间】：2018-11-24 23:06:10
【问题描述】：

我正在尝试记录我的 Angular + Typescript 应用程序。我正在为此使用 Compodoc。我通过运行命令使用 npm 安装了 compodoc

   'npm install -g compodoc'. And added 

   "compodoc": "./node_modules/.bin/compodoc -p src/tsconfig.json"

在我的 package.json 脚本中。当我运行 npm run compodoc 时出现此错误

PS D:\Moya Proj\VITMOAPPPHYD2016> npm run compodoc

moya-app@0.0.0 compodoc D:\Moya Proj\VITMOBAPPPHYD2016 compodoc -p src/tsconfig.json

                                            _
                                           | |
    ___    ___    _ __ ___    _ __     ___     __| |   ___     ___
   / __|  / _ \  | '_ ` _ \  | '_ \   / _ \   / _` |  / _ \   / __|
  | (__  | (_) | | | | | | | | |_) | | (_) | | (_| | | (_) | | (__   0.0.41
   \___|  \___/  |_| |_| |_| | .__/   \___/   \__,_|  \___/   \___|
                       | |
                       |_|

[11:08:57] 在当前目录中找不到“tsconfig.json”文件 npm ERR！代码生命周期

npm 错误！错误号 1

npm 错误！ moya-app@0.0.0 compodoc: compodoc -p src/tsconfig.json

npm 错误！退出状态 1

npm 错误！

npm 错误！ moya-app@0.0.0 compodoc 脚本失败。

npm 错误！这可能不是 npm 的问题。上面可能还有额外的日志输出。

npm 错误！可以在以下位置找到此运行的完整日志：

npm 错误！ C:\Users\Shahid.tabrez\AppData\Roaming\npm-cache_logs\2018-06-15T05_38_57_267Z-debug.log

我应该在我的 tsconfig.json 中添加任何内容还是我所做的有什么问题。提前致谢。

【问题讨论】：

观看此视频：youtu.be/xJSKZ1DE4GoSimon 详细解释它是如何安装的
谢谢，但我找到了答案。我应该运行这个'compodoc -p ./tsconfig.json'
非常感谢，你救了我的命。我也收到 tsconfig.json not found 错误，但尝试运行 compodoc -p ./tsconfig.json ，它工作正常。

标签： angular typescript npm documentation

【解决方案1】：

只需检查 package.json 文件中“scripts”对象下的路径是否正确提及。默认情况下，路径是“src/tsconfig.app.json”。如果你的 tsconfig.app.json 不在上面提到的路径，修改路径检查一下，肯定可以的

【讨论】：