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

我对JavaScript和nodejs的使用经验有限。

当我阅读这个nodejs api文档时 ，它为我提出了一些问题。

1. 在这种特殊情况下，他们使用唯一的例子告诉我callback中的1参数是'err'？
2. outlook未来，除非另有说明，否则我认为callback中只有'err'参数？
3. 在我看来，callback参数应该以通用模式列出，如下面的标题中的"callback <Function>" 。 为什么我在这个想法中错了？
4. 是否有一个标准的文档生成工具，如JavaScript中的javadoc？

Answer 1

关于fs文档 ：

asynchronous表单总是将完成callback作为最后一个参数。 传递给完成callback的参数取决于方法，但第一个参数总是保留给一个exception。 如果操作成功完成，则第一个参数将为null或undefined 。

所以，是的，假设callbackfs方法有签名(err)除非另有说明。 除非另有说明，否则不应认为这是其他软件包的签名。

是否有一个标准的文档生成工具，如JavaScript中的javadoc？

有哪些选项可用于logging您的Javascript代码？

Answer 2

一般来说，callback的参数总是为每个函数logging。 但是，在callback没有任何争论的情况下，他们根本不会被提及。

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

所以文档一般：

1. 文件参数callback。

2. 如果callback的唯一参数是一个错误（这意味着callback没有产生有用的值），那么不会提及任何东西。

3. logging所有callback偏离上述任何一种情况（根本没有参数或没有错误参数）。

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