api - Apdocjs 文档创建问题，警告：找不到插件参数解析器和缺少逗号问题

Question

我尝试使用 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 相关的标签

score 5 · Accepted Answer

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

您可能有语法问题或其他一些配置问题。就我而言，自从更新以来，我使用 @param 以 javadoc 样式记录了一些函数...这曾经被忽略，但现在会引发警告。

score 3 · Accepted Answer

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

当 api 文档生成时，它会生成带有 @param 的 main.js 文件。并且因为@param 也将在下一次生成时被检查，你可以跳过那个输出目录，一切都很好。

score 2 · Accepted Answer

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

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

score 0 · Accepted Answer

我在使用 erlang 的钢筋中遇到了同样的问题，我所做的是在项目根文件夹中：

rm -rf doc/

然后我再次运行 apidoc

信息：Done

score 0 · Accepted Answer

我有同样的问题。我正在使用自定义模板，并且模板文件夹与我的 *.js 文件位于相同的位置，这些文件被解析，包括 main.js 模板文件。-e 选项对我不起作用，所以我将模板文件夹移动到其他位置，一切正常。

score 0 · Accepted Answer

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

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

6 回答 6