在Swift中为函数生成doc

Question

我有一段时间寻找一种使用Swift自动为Xcode中的函数生成文档的方法。

我知道如何逐行手动生成它，但至少对我而言，这样做是令人讨厌的，你必须手动指定所有内容和这个成本时间。

您必须使用:param:指定每个参数，并使用其名称跟随它，并使用:returns:返回函数，所有这些都在您的手中。

在PHP中，例如使用类似Swift的符号，您可以在函数/**上方键入，然后按 Enter 键并完成函数的文档，您有仅输入每个参数的详细信息和功能说明。以我的拙见，它恢复了对您的代码进行评论的部分工作。

我试图找到快捷方式的密钥，这样做的代码片段，但我找不到任何东西。我想知道是否有办法在Xcode中使用至少使用Swift。任何建议都非常感谢。

Answer 1

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

它非常易于使用，只需在C＃中输入///就像在C＃中一样，并且会发生魔术，它会自动为函数生成Javadoc样式。

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

安装插件

与Xcode 6 +完全兼容。

我希望这有助于某人。