如何将 Apple API 文档翻译成现实生活中的代码？

Posted 2023-02-24

【中文标题】如何将 Apple API 文档翻译成现实生活中的代码？

【英文标题】：How do I translate Apple API documentation in to real life code?

【发布时间】：2016-07-07 00:30:46

【问题描述】：

我发现在 Swift 和 Xcode 中学习新事物的这一方面非常令人费解。

我似乎无法从我在 Apple API 文档中阅读的内容中解读出我需要编写的实际代码；在我的具体情况下：API Reference for 'PlaygroundSupport'，以及我需要的实际代码，即：

import PlaygroundSupport
let containerView = UIView(frame: CGRect(x: 0.0, y: 0.0, width: 375.0, height: 667.0))
PlaygroundPage.current.liveView = containerView

对我来说，这似乎是我无法从 API 中猜到的“隐藏知识”。没有给出示例用法。

如何从 Apple API 中找出我需要以所需方式添加 UIView（作为 containerView）？我如何学习以假定的方式阅读 Apple API 文档？

【问题讨论】：

为什么有人会否决我的问题？！​​

我没有投反对票，但是：您没有解释您实际上要解决的问题。我从您的问题中得到的只是您对文档不满意。在不知道您要达到的最终目标的情况下，我无法建议您还应该阅读哪些内容，或者您​​应该调查哪些其他帮助途径。

【参考方案1】：

阅读 API 文档很像阅读数学教科书：您需要理解正在阅读的每个单词，否则您可能会错过所需的内容。在这种情况下，检查该文档，您可能会查看 PlaygroundPage 类，并且您会看到 liveView 属性被描述为“助手时间轴中的活动实时视图”。如果您不确定什么是“实时视图”或什么是“助理时间线”，则可能需要进行一些进一步的搜索。但是，如果您知道这些术语，您应该立即将其识别为您正在寻找的财产！

继续浏览文档并确保您对每种方法或属性有足够的了解，以明确排除或进一步研究它。一开始可能会让人不知所措，但是当您阅读 Swift iBook、遵循教程并继续阅读文档时，您会发现自己越来越理解其中的内容。

【讨论】：

我希望我举一个例子来说明这个特定的 API 在哪里说什么以及它需要什么，但无法弄清楚你在哪里发现缺失的链接是什么。因此，我给出了这个特定 API 的链接（很短），希望有人会说“这行/短语有点意思……”因为我已经阅读了所有 Swift 书籍，我已经完成了其中的一切；我已经阅读了大多数 Apple 教程，但每次我都需要查找 API 来扩展我的知识......砰，我一次又一次地陷入这种僵局。

"liveView - 助理时间轴中的活动实时视图。"此行表示您将liveView 属性设置为的任何视图都将出现在助手时间轴中。由于您想要（我收集）是在助手时间轴中显示一个视图，因此从这行文档中可以清楚地看出，您需要做的是将 liveView 属性设置为您希望显示的任何视图。

点击啊哈！谢谢。 :)

【参考方案2】：

正如@andyvn22 所提到的，学习如何使用文档、了解它试图与您交流并进行实验的方式只是需要时间。我将向您展示我的思考过程：

您链接的页面有一个 import PlaygroundSupport，我可以看到有一个类 PlaygroundPage - 假设您想在 Playground 中使用渲染 UI，我会深入研究。 PlaygroundPage 似乎有一个名为liveView 的属性，它似乎可以让我与某些东西实时交互，所以点击那里...https://developer.apple.com/reference/playgroundsupport/playgroundpage 我可以看到liveView 是一个get/set，所以我知道我需要传递一些东西，也许是我想在操场上渲染的视图对象？让我们点击该视图必须符合的PlaygroundLiveViewable 协议...https://developer.apple.com/reference/playgroundsupport/playgroundpage/1964506-liveview 啊，所以 UIView 或 UIViewController 符合 PlaygroundLiveViewable 协议 - 如果我尝试通过它，那么它就像您在问题 https://developer.apple.com/reference/playgroundsupport/playgroundliveviewable 中确定的那样工作

这并不总是那么简单，因为让我们面对现实吧，为刚刚适应的语言编写文档是一项挑战。我建议巩固一些软件工程基础，例如分类、子类化、get/set 范式，你学习的越多，你就会发现更多的模式，并且更容易遵循文档！