Firebase 文档标准？答案

【问题标题】：Firebase documentation standards?Firebase 文档标准？
【发布时间】：2020-07-29 11:31:31
【问题描述】：

我在 Firebase 文档页面上看到了这个 sn-p，它解释了一种方法。有没有关于如何阅读本文档的文档？

onSnapshot ( options :  SnapshotListenOptions ,  observer :  { complete ?: ( ) => void ; error ?: ( error :  Error ) => void ; next ?: ( snapshot :  QuerySnapshot < T > ) => void } ) : ( ) => void

据我了解，Javascript 没有函数的类型化参数，尽管我是一个尝试构建我的第一个现代 Web 应用程序的 Javascript 新手。我什至不知道如何阅读此文档。任何指针都会有所帮助。

【问题讨论】：

您的问题是关于理解 Firebase 及其作为 API 的集成？你可以阅读这篇文章，看看它是否为你提供了正确的答案Firebase Understanding snapshop.child()
我的问题是关于如何阅读 API 文档。自 90 年代末以来我就没有编写过 Javascript，所以我猜从那时起语言发生了一些变化。
一般编程书籍（早在我们有这些的时候）都有一个符号部分解释如何阅读文档。我找不到这个文档。
您在这里看到的是 TypeScript，它是 JavaScript 的超集，添加了声明性类型系统。
@FrankvanPuffelen 谢谢！我找到了一个 TypeScript 规范，它似乎正是我正在寻找的文档：github.com/Microsoft/TypeScript/blob/master/doc/spec.md你能重新提交你的评论作为答案吗？

标签： javascript firebase

【解决方案1】：

您在这里看到的是 TypeScript，它是 JavaScript 的超集，添加了声明性类型系统。

如今，许多新的 API 被定义为 TypeScript（通常在以 .ts 结尾的文件中），并且现有的 API 也使用 TypeScript 类型进行了重铸（通过为它们创建单独的 .d.ts 文件）。您仍然可以根据需要将它们用作旧的 JavaScript，但您也可以使用新的类型系统并获得类型检查的好处。

【讨论】：

【解决方案2】：

在这种情况下：

onSnapShot 是一个函数，因为我们使用 onSnapShot ( 打开而不是 onSnapShot {，这将是一个对象；
onSnapShot 有参数 options, observer
complete ?: ( ) => void ; 表示对象 observer 可选地有一个名为 complete 的属性，它是一个函数（()=> 被称为箭头函数，相当于 python 的 lambda 表达式）并且该完整应该不返回任何内容（或者它的返回结果将被忽略）。
onSnapshot 返回无效。

re：类型：你说得对，因为 javascript 没有显式强制类型化参数，但 onSnapShot 期望包含所有（必需）属性的东西在 SnapshotListenOptions 中记录并不是不合理的.所以下一步是深入SnapshotListenOptions 看看需要什么。

如果你真的喜欢打字语言，打字稿总是有的。

【讨论】：

感谢您的解释。是否有定义这种格式的通用文档，特别是规范中每个字符的含义？在 C++ 或 Java 等语言中，函数签名可由编译器解析，是否有用于此类函数签名的“编译器”？
也许是这个？ typescriptlang.org/docs/handbook/basic-types.html 文档似乎与打字稿格式相当一致......
我看到您在上面的问题的 cmets 中找到了更好的参考 ^