iOS框架和库的文档
如何在Jazzy中为Swift项目生成文档
Jazzy是一个很棒的开源工具，可以为您用Swift编写的代码生成Apple风格的文档。 Jazzy创建了一堆HTML页面，这些页面可以包含代码的每个部分以及其中编写的文档。 它是命令行实用程序/工具，易于使用。
Jazzy工具自动为用Swift编写的框架，pod或库创建与Apple官方参考文档匹配的文档，而无需在Xcode之外编写任何代码。 结果将是一堆HTML文件，这些文件看起来几乎与Apple为其框架提供的文档一样。
这是一个如何在Swift中注释方法的基本示例：
/ **
–参数视图：
–参数标题：
–参数消息：
–参数样式：
* /
进口基金会
导入UIKit
///生成警报和操作表
公共类警报{
// MARK：公共方法
/ **
显示当前视图控制器的警报。
–参数视图：在其上显示警报的视图。 应该使用self，或者如果从viewDidLoad（）方法调用，则使用根视图控制器。
–参数标题：警报标题
–参数消息：警报中显示的主要消息
–参数样式：警报措施的类型。 请参阅Apple文档中的UIAlertActionStyle枚举。
* /
public func showAlert（view：UIViewController，title：String，message：String，style：UIAlertActionStyle）{
让警报= UIAlertController（标题：标题，消息：消息，preferredStyle：UIAlertControllerStyle.Alert）
setAction（警告，样式：样式）
view.presentViewController（警告，动画：true，完成：无）
}
/ **
在当前视图控制器上显示操作表。
–参数视图：在其上显示操作表的视图。 应该使用self，或者如果从viewDidLoad（）方法调用，则使用根视图控制器。
–参数标题：操作表标题
–参数消息：操作表中显示的主要消息
–参数样式：动作表动作的类型。 请参阅Apple文档中的UIAlertActionStyle枚举。
* /
public func showActionSheet（view：UIViewController，title：String，message：String，style：UIAlertActionStyle）{
让警报= UIAlertController（标题：标题，消息：消息，preferredStyle：UIAlertControllerStyle.ActionSheet）
setAction（警告，样式：样式）
view.presentViewController（警告，动画：true，完成：无）
}
// MARK：私有方法
/ **
设置给定警报或操作表的默认操作
–参数警报：对其执行操作的警报控制器
–参数样式：动作样式。 请参阅Apple文档中的UIAlertActionStyle枚举。
* /
私有函数setAction（让警报：UIAlertController，样式：UIAlertActionStyle）{
}
}
Jazzy，一个由Realm的人开发的开源项目。
安装Jazzy
- 须藤宝石安装爵士
上面的终端命令可能失败。 第一个命令不起作用的原因是El Capitan中引入了新的系统完整性保护功能，该功能甚至限制了管理员写入/ usr / bin
2. sudo gem install -n / usr / local / bin GEM_NAME_HERE
安装过程完成后，使用终端导航到您的项目，只需在项目根目录内键入jazzy。
3.爵士
上面的命令将生成文档
里面有很多HTML和JS文件，但是您只需打开index.html，然后弹出整个文档。 示例如下：
不仅可以在终端中键入jazzy ，还可以传递几个参数，这些参数将覆盖默认行为。
4. jazzy --min-acl private
这将生成两个部分，私有和公共部分，如下所示：
5. jazzy --min-acl internal
这将不包括尚未标记为公共的类或其他结构。
Jazzy默认情况下只为显式声明为public的类和方法生成文档，这就是为什么我们必须在类本身和方法中添加public关键字的原因。 但是，您也可以选择为代码的私有部分生成文档。