为 Swift 中的函数生成文档

Question

我一直在寻找一种方法来使用 Swift 自动为 Xcode 中的函数生成文档。

我知道如何逐行手动生成它，但至少对我来说，这是一种令人讨厌的方式，您必须手动指定所有内容，这会花费时间。

您必须用 :param: 指定每个参数及其名称，然后用 :returns: 指定函数的 return，全部由您亲手完成。

在 PHP 中，例如使用像 Swift 这样的符号，您可以在函数上方键入 /**，然后按 Enter 键并完成函数的文档，您只需输入每个参数的详细信息和函数的描述。以我的拙见，它恢复了评论代码的部分工作。

我试图找到快捷键、执行此操作的代码片段，但我没有找到任何东西。我想知道是否有办法在 Xcode 中至少使用 Swift 来做到这一点。非常感谢任何建议。

Answer 1

在我继续研究之后，我发现了一个非常出色的 Swift 和 Objective-C 文档生成器，名为 VVDocumenter-Xcode。

它真的很容易使用，只需像在 C# 中一样在您的函数中键入 ///，神奇的事情就会发生，它会自动为该函数生成 Javadoc 样式。

我强烈建议使用包管理器 Alcatraz

安装 插件

完全兼容 Xcode 6+。

我希望这对某人有所帮助。