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

时间:2010-03-19 09:35:51

标签: objective-c xcode documentation-generation

我知道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 {...

4 个答案:

答案 0 :(得分:7)

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

修改: 以下是脚本的更新版本:https://github.com/premosystems/DoxygenXCodeHelper

答案 1 :(得分:2)

我在Xcode 5中成功使用VVDocumenter-Xcode,效果很好。当您在方法上方输入“///”时,它会自动生成特定于方法的模板。

答案 2 :(得分:1)

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

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

答案 3 :(得分:0)

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

- 弗兰克