试图了解nodejs文档。如何发现回调参数

Question

当我读到这个Node.js API docs时，它为我提出了一些问题。

1. 在这种特殊情况下，他们使用的唯一的例子是告诉我回调中的1参数是'错误'吗？
2. 除非另有说明，否则我认为回调中只有'err'参数？
3. 在我看来，回调参数应该以一个共同的模式列出，就像这里：标题中的"callback <Function>"。为什么我的想法错了？

Answer 1

Documentation on fs：

异步形式总是将完成回调作为其最后一个参数。传递给完成回调的参数取决于方法，但第一个参数始终保留用于异常。如果操作成功完成，那么第一个参数将是null或undefined。

所以，是的，假设回调fs方法有签名(err)除非另有说明。您不应该认为这是其他包的签名，除非它被类似地注明。

在javascript中是否有像javadoc这样的标准doc生成工具？

What options are available for documenting your Javascript code?

Answer 2

通常，每个函数都会记录回调的参数。但是，如果回调没有任何参数，则根本不会提及它们。

另一方面，回调的第一个参数是为错误保留的（因为异步函数不能正确地抛出错误）。因此，如果回调期望没有参数，那么它应该期望的唯一参数是错误。

所以文档一般：

1. 记录回调的参数。
2. 如果回调的唯一参数是错误，则不提及任何内容（这意味着回调不会产生有用的值）。
3. 记录回调偏离上述任何一种情况的所有情况（根本没有参数或没有错误参数）。

所以在具体情况下你提到。是的，这个例子是正确的。错误是该函数回调的唯一参数 - 因此没有提到回调参数。