Apidocjs 文档创建问题,警告:找不到插件参数解析器和缺少逗号问题



我尝试使用 apidocjs 创建 API 文档,但在编译项目以在项目文件夹上使用 apidoc.json 创建 apidoc 时遇到了问题。

在这里代码:

~$ apidoc -i ./ -o apidoc/

和结果

warning: parser plugin 'param' not found.
error:   Error: Can not read: apidoc.json, please check the format (e.g. missing comma).

请任何人帮助我解决此问题

与 apidocjs.com 相关的标签

如果您

使用的是@apiVersion功能,按照@Prasanth的建议删除 apidoc 目标文件夹破坏您的历史记录。重建它的唯一方法是检查并签出每个版本,然后运行 apidoc。因此,如果要使用版本控制。这不是你的答案。

您可能遇到语法问题或其他一些配置问题。就我而言,自从更新以来,我有一些以 javadoc 风格记录的函数,@param......这曾经被忽略,但现在抛出警告。

~$  apidoc -i ./ -e apidoc/ -o apidoc/

当 API 文档生成时,它会生成带有@param的主文件.js文件。由于该@param也将在下次生成时进行检查,因此您可以跳过该输出目录,一切都很好。

问题也为我修复了,此错误来自生成的docs/main.js。通常我们应该只解析必要的文件,以生成这个 apiDoc。

我在命令中使用了 -f .php,就像 apidoc -f .php -i ./ -o ./ 一样。这就像一个奇迹。

我也有同样的概率。我正在使用自定义模板,模板文件夹与解析的 *.js 文件位于同一位置,包括主模板文件.js模板文件。-e 选项对我不起作用,所以我将模板文件夹移动到其他位置,一切正常。

我在使用 erlang 的 rebar 中遇到了同样的问题,我所做的是在项目根文件夹中:

rm -rf doc/

然后我再次运行阿皮多克

信息: Done

要修复此错误,您可以尝试保存 package.json 和 apidoc.json,而不带 UTF-BOM 符号。apidoc 的某些版本、部分或依赖项使用与此类似的代码

JSON.parse(fs.readFileSync(file, 'utf-8')) // throw "Uncaught SyntaxError: Unexpected token  in JSON at position 0"

最新更新