使用compodoc编写角项目文档

Question

我试图记录我的棱角+打字申请。我要用Compodoc来做这个。我通过运行以下命令使用npm安装compodoc

   'npm install -g compodoc'. And added 

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

在我的package.json脚本中。当我运行npm运行compodoc时，我得到了这个错误

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

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

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

11:08:57 "tsconfig.json“文件在当前目录npm中找不到！代码ELIFECYCLE npm错误！错误号1 npm错误！moya-app@0.0.0 compodoc: compodoc -p src/tsconfig.json npm错误！退出状态1 npm错误！ npm错误！在moya@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中添加任何内容，或者在我所做的事情中是否有任何错误。提前谢谢。

Answer 1

只需检查package.json文件中的“脚本”对象下是否正确地提到了路径。默认情况下，路径是"src/tsconfig.app.json“。如果您的tsconfig.app.json不在上述路径上，请修改路径并进行检查，它将绝对工作。