向您的iOS应用添加帮助
我现在在应用商店中有9个应用，每个应用都有一个“帮助”组件。 前几个应用程序仅显示了一个UIWebView以及一些链接的html页面。 完全没有上下文。
现在，我已经开发了一些代码，这些代码使我可以轻松添加特定于视图的帮助，而只为希望显示帮助的每个视图添加几行代码。
冒着使自己陷入困境并遭受经验丰富的开发人员的愤怒的可能，这些开发人员可能会批评我的代码，Swift开发社区的开放共享使我感到鼓舞，我可以免费使用该代码并记录如何使用它。
YouTube教程
如果您想观看安装和配置的完成方式，请观看https://www.youtube.com/watch?v=WcUkahx3j8s
安装
您可以从我的GitHub页面获取CTHelp和示例应用程序，网址为https://github.com/StewartLynch/CTHelp
如果您从GitHub克隆或下载了CTHelp，您将能够看到并测试示例应用程序。 要将其集成到项目中，您要做的就是确保已为应用程序初始化CocoaPods，然后将以下内容添加到podfile中。
并运行pod Install
您现在可以为您的项目打开.xcworkspace
向ViewController添加帮助
对于您希望添加帮助的任何ViewController，可以执行以下操作：
- 在您的ViewController中导入CTHelp
- 创建一个按钮，该按钮将请求通过其操作显示帮助。
- 在操作内，执行以下代码，或编写将实现该代码并在操作内调用该函数的函数。
代码
最简单的实现方法是通过创建CTHelp的新实例，从以下代码开始代码：
让ctHelp = CTHelp（）
现在，您可以按住Option键单击 CTHelp（）类名称以显示快速帮助 。 在声明之后复制所有代码，并将其粘贴到您的函数中。
例
这就是您的动作。
每个CTHelpItem具有三个必需的参数。
CTHelpItem（标题：字符串，helpText：字符串>，imageName：字符串）
如果将helpText留为空字符串“”，则图像将占据整个视图。 如果imageName保留为空字符串，则helpText将占据整个视图。 如果两者都存在，则图像视图将显示具有该名称的图像并将其缩放到最大240px X 230px。 剩余的高度将由helpText占用。 因此，最好将图像设计为宽度为240 px，并具有一定的高度，以允许在视图中显示helpText。 如果文本大于textview中适合的文本，则视图将滚动。
注意：必须将具有指定名称的图像添加到项目的资产中
CTHelp.appendDefaults
帮助卡堆栈的末尾可以显示两个可选卡。 如果您选择不使用appendDefaults功能，则不会添加其他卡。
ctHelp.appendDefaults（companyName：String，emailAddress：String ?, data：Data ?, webSite：String ?, companyImageName：String？）
电子邮件地址
如果您为emailAddress分配一个值，则会创建并显示一张新卡，询问用户是否希望与开发人员联系。 指定的电子邮件地址将是电子邮件发送到的地址。
如果在调用appendDefaults函数之前，您收集了应用程序的数据并将其分配给Data（）对象，则可以将其分配给data参数。 如果不是零，还将询问用户是否要将应用程序数据附加到电子邮件。
注意：有关如何收集和编码数据的示例，请参见示例项目。
电子邮件的措辞在CTHelp / CTEmailFunctions.swift文件中进行配置，并且是sendEmail （）函数。 您会注意到，消息的正文还包括用户信息，例如设备类型，iOS版本和应用程序版本。
网站
如果您为webSite分配值，则使用companyImageName中指定的名称显示带有图像的卡片，以及一些文本，要求用户单击按钮，该按钮会将用户带到webSite地址中定义的公司网站。 文本的措辞是在CTHelp / Models / CTHelp.swift文件本身中的appendDefaults函数中定义的。 您使用的图像必须是您的资产之一。
显示帮助ViewController
CTHelp.present（来自：UIViewController）
始终使用self作为呈现的viewController。 在我们的例子中，CTHelp的实例称为ctHelp ，因此我们可以使用
ctHelp.presentHelp（来自： self ）
更改颜色以匹配您的主题
如果要修改卡的颜色，可以使用示例代码中提供的可选变量来更改它们的颜色。
取消注释所需的任何注释，并更改颜色以适合您的主题。
通过更改颜色，可以更改帮助卡的外观。
感谢和赞赏
我要感谢和感谢Swift社区中的以下人员。 我从未见过这些绅士，但是他们通过文字，播客和YouTube视频所做的不懈贡献和指导，启发并鼓励我分享我所知不多的知识，希望对您有所帮助。 我强烈建议您查看他们的Twitter帐户，网站，视频和播客。 您会在我的身上认识很多。
保罗·哈德森 （Paul Hudson）@twostraws
Swift的作者，YouTuber，会议主持人和Swift Over Coffee播客。
肖恩·艾伦 （@seanallen_dev）
YouTuber和Swift Over Coffee播客
马克·莫肯 （ Mark Moeykens） （@bigmtnstudio）
YouTuber
约翰·桑德尔（@swiftbysundell）
作者和每周播客。
FireSide Swift （@fireside_swift）
与Stephen和Zack进行的每周播客。
最后但并非最不重要的
如果我也不同意的话，我将不知所措 （ Aurimas Mixas P. ）
他看到了这篇文章，并建议将其安装为cocoapod会更好。 我不知道该怎么做，在我进行研究时，他足够亲切地待在我身边几天。 他和我一起工作（并纠正了我的错误和遗漏），我终于使它被接受。
最后，我希望您能提供反馈意见并在Twitter上关注我。 我是@StewartLynch
如果您想了解更多有关我的旅程的信息，请在Medium上查看我的第一个博客。
我可以称自己为软件开发人员吗？
https://medium.com/@stewartlynch/can-i-call-myself-a-software-developer-ca03ac3f37aa