是否有一个类似 Javadoc 的 Xcode 插件可以自动生成 doc 模板？答案

【问题标题】：Is there a Javadoc-like plugin for Xcode that automatically generates the doc template?是否有一个类似 Javadoc 的 Xcode 插件可以自动生成 doc 模板？
【发布时间】：2011-01-29 09:23:17
【问题描述】：

我知道 Doxygen 可以生成文档。我正在寻找的是在 Xcode 中插入文档的快速方法，类似于 Eclipse 在编辑 Java 文件时所做的。

假设我有一个带有如下参数的 Objective-c 方法：

-(NSInteger*) sumOf: (NSInteger*) one and:(NSInteger*) two {...

在 Eclipse 中，如果您将光标放在方法上方并输入：/**<Enter>，您将获得一个预先填充有 @param 和 @return 标记的 Javadoc 模板。

是否有可能在 Xcode 中实现类似的功能？输入/**<Enter> 后，我想自动获取：

/**
 *
 * @param one
 * @param two
 * 
 * @return
 */
 -(NSInteger*) sumOf: (NSInteger*) one and:(NSInteger*) two {...

【问题讨论】：

现在可以在 Xcode 5 中实现。请参阅此帖子中的答案：stackoverflow.com/a/18899696/1130270

标签： objective-c xcode documentation-generation

【解决方案1】：

http://www.duckrowing.com/2011/05/14/using-the-doxygen-helper-in-xcode-4/ 此处的脚本完全符合您的要求。

编辑：这是脚本的更新版本：https://github.com/premosystems/DoxygenXCodeHelper

【讨论】：

【解决方案2】：

我在 Xcode 5 中成功使用了VVDocumenter-Xcode，它运行良好。当您在方法上方输入“///”时，它会自动生成特定于方法的模板。

【讨论】：

【解决方案3】：

“用户脚本”菜单（Xcode 菜单栏中的黑色小滚动图标）有一个 HeaderDoc 子菜单，其中包含用于高清语法的各种文档标记的模板。您可以通过转到 Xcode 的“首选项”窗口中的“键绑定”来为要使用的项目设置键盘快捷键。

由于用户脚本本质上是 shell 脚本，因此您可以使用任何脚本语言来编写自己的脚本，因此如果您愿意，您甚至可以编写一个小正则表达式辅助脚本来解析所选行中的参数名称并填写HeaderDoc 评论的基础知识。

【讨论】：

【解决方案4】：

如果您有耐心，请查看 here，因为它解释了 XCode 中的完成行为和覆盖。我不知道这是否适用于评论集，但这似乎是一个好的开始。

-- 弗兰克

【讨论】：