Tag: 文档

快速实现Objective-C-第1部分: Objective-C仍然值得花时间吗？目前，我只能说swift与Objective-C一起工作，在我们的应用程序的核心，我们仍然有它的线索。基础在Objective-C中，我们有两种文件类型：头文件和实现文件。在头文件中，我们将解释在编码结束时应该具有的内容，我们不必将实现文件实现到另一个实现文件中，只需添加头文件，然后完成即可。在开始编写代码之前，我将从编码的重要部分开始，您应该能够在一个大团队中解释您的代码，因此，这是Objective-C中的一些文档规则 / *！ @brief它将温度度从华氏度转换为摄氏度。 @discussion该方法接受一个表示温度的浮点值，该值以华氏度表示，并将其转换为摄氏温度刻度。要使用它，只需调用@c [self toCelsius：50 ]; @param fromFahrenheit输入值，代表华氏度的度数。 @码 float f = [self toCelsius：80]; @return float摄氏度的度数。 * /

框架星期五：爵士乐: 欢迎大家回来，我很高兴你们回来了另一个精彩的Framework Friday帖子。今天，我们将回顾我的个人最爱：Jazzy（https://github.com/realm/jazzy）。 Jazzy是由Realm的杰出人士构建而成的，因此请在此处查看他们：https://realm.io/ 什么是爵士乐？ jazzy是一个命令行实用程序，可为Swift或Objective-C生成文档。与解析源文件不同，Jazzy钩接到Clang和SourceKit中，以使用代码的AST表示及其注释来获得更准确的结果。输出结果与Apple官方参考文档（WWDC 2014之后）的外观相符。从本质上讲，爵士乐将使您的生活更加有趣，并使生活变得更好十倍😉 爵士乐在几乎所有方面都非常简单。安装Jazzy只需从我们的终端执行一个命令： [sudo] gem install jazzy 塔达，都做完了接下来，我们必须在代码中添加注释。使用Jazzy会使这个过程变得非常有趣，因为说完并完成之后，我们将获得一个显示我们评论的网页！在开始记录代码之前，我们需要了解Markdown语法。基本上，Markdown语法使用特殊字符来格式化文本。这里有一些资源，其中包含有关Markdown语法的更多信息：https://guides.github.com/features/mastering-markdown/和https://confluence.atlassian.com/bitbucketserver/markdown-syntax-guide- 776639995.html。让我们看一些基本知识。 1.＃此文本现在是标题＃ 2. *此文本将以斜体显示* 3. **This text will be bold** 如果将主题标签放在一段文本之前，它将变成标题。在此之前和之后添加更多＃会更改文本的大小。在一行文本之前和之后仅添加一个星号将使其斜体。前后添加两个星号将使其加粗。很简单吧？ *我的无序列表项目1 *我的无序列表项目2 在文本前面仅添加一个星号会将其转换为无序列表（项目符号点）。 1.我的订购清单项目1 1.我的订购清单项目2 1.我的订购清单项目3 同样，不添加星号，而是添加“ 1.”会将您的文本转换为有序列表。现在我们已经解决了这个问题，让我们将其付诸实践。在此处下载示例项目：https://github.com/kennyDang/Guides/tree/master/Framework%20Fridays/Jazzy%20Example 在示例项目中，您将看到我们有几个不同的文件夹。一个叫做协议，另一个叫做模型。如果您对它们进行了窥视，将会看到一些超简单的文件和已记录的代码。我们唯一的协议称为SuperCoolProtocol ，只有一个函数称为displayCoolMessage。我不知道当我们遵守此协议时会发生什么……好事，我们有文档的力量！我们不必猜测它的作用，因此让我们看一下评论。 […]

如何使用Dynamsoft iOS相机SDK: 几周前，Dynamsoft发布了一个iOS相机SDK，旨在帮助开发人员快速构建适用于iOS平台的文档扫描应用。在本文中，我将分享如何在Xcode中配置SDK，以及如何从头开始创建简单的文档扫描器应用程序。适用于iOS 1.0的Dynamsoft Camera SDK Xcode 9.2 迅捷4.0 在使用SDK之前，您最好了解不同类之间的关系。打开Xcode，然后按Shift + Command + N创建一个Single View App。在Xcode中构建项目时，出现以下错误：这是StackOverflow的解决方案：关闭Xcode。打开钥匙链。在本地中找到iOS开发者证书。将证书从“本地”拖放到“系统”选项卡。出现提示时输入管理员密码。启动Xcode并为您的设备构建项目。将DynamsoftCameraSDK.framework拖到您的项目中。确保选中“如果需要复制项目”。该SDK取决于sqlite3和stdc ++ 。单击项目设置>常规，添加libsqlite3.tbd和libstdc ++。tbd 。如果要使用视频视图实时扫描文档，请单击项目设置>信息以添加“隐私-相机使用说明”。如果没有此属性，则会收到错误消息： 2018-02-02 15:55:08.511904+0800 docscanner[4310:948418] [MC] System group container for systemgroup.com.apple.configurationprofiles path is /private/var/containers/Shared/SystemGroup/systemgroup.com.apple.configurationprofiles 2018-02-02 15:55:08.511904+0800 docscanner[4310:948418] [MC] System group container […]

生成并托管您的iOS文档: 作为程序员，每个人都告诉您要负责并编写代码。它为您正在编写的代码提供了上下文，并使您更容易了解正在发生的事情。记录我们的代码很棒，但是如果我们可以直接从代码中生成并托管漂亮的文档，该怎么办？通过正确的设置，我们甚至可以搜索文档。请看下面的样本文档页面： BackgroundColorState枚举参考可以通过用下一个后台状态覆盖状态来更新状态。 jgsamudio.github.io 有什么计划？在这篇文章中，我们将使用Jazzy为我们的文档生成一个网站。然后学习如何在Github Pages上托管它，最后确保它与Travis CI保持最新。如果您不熟悉CI或尚未为项目设置Travis CI，请查看此博客以获取一些见解：“如何为CI和iOS Project自动化CI” 产生文件开发人员可以尽可能快地编写文档，但速度却已过时。我们需要一种生成文档的方法，这样就可以避免在很多地方都必须更新文档。 Jazzy是一个命令行应用程序，可以将Swift和Objective-C文档生成到html网站中。爵士安装在安装Jazzy之前，我们需要安装“ Xcode命令行工具”。您可以运行以下命令来安装它们： xcode-select —-install 。安装完成后，您可以运行[sudo] gem install jazzy来安装Jazzy。成功安装后，我们可以运行Jazzy并使用不同的文档选项对其进行自定义。爵士乐 –min-acl内部\ –no-hide-documentation-coverage \ -主题全角\ –output ./docs \ –documentation =。/ *。md 1. min-acl内部 min-acl属性控制生成的最低访问级别。由于我们正在记录所有公共函数和变量，因此将其设置为internal 。私有和Fileprivate函数和变量将不在生成的文档中。要记录所有内容，必须将min-acl设置为private 。 2.无隐藏文档覆盖在文档中启用文档百分比计数器。 3.主题全角使用搜索栏更改为自定义主题。 […]

在Swift中记录: 我们没有任何借口：记录我们的代码从未如此简单。 Swift工程师做了出色的工作，为我们提供了一种众所周知的简单方式来保持我们的代码记录：标记语言。我制作了一个信息图，为您提供实现此目的最有用的技巧。以下是简要概述。我们需要知道的所有内容可以通过两件事进行综合：如何格式化以及Swift如何组织和显示文档。如何格式化我们几乎可以使用任何markdown语法在Swift代码中格式化我们的文档：预定义的标题，强，斜体，项目符号列表，编号列表，链接，嵌入式代码等。 Swift如何组织和显示您的文档 Swift使用以下部分按此顺序组织方法的文档（我们只需要使用正确的关键字来激活可选的关键字即可）：说明（默认）：在这里我们可以指定很多东西：作者，版权，警告，注释，版本等。参数（可选）退货（可选）抛出（可选）例如：然后，在Option上单击我们的方法或在实用工具栏中选择询问标记时，将显示格式化的文档：我们还可以使用一些注释标签来分隔代码： //标记： // 去做： // 整我：例如：这将显示在我们代码上方的栏中：我们可以使用Jazzy以精美的方式呈现文档。坦白地说，为了我们的团队成员或将来的自己，每个人都应该这样做，因为从现在开始的几个月内，他们将与我们自己的代码取得联系。