在Objective C中自动插入标题文档注释？

Question

由于XCode 5现在支持直接从头文件读取标题注释,因此以一致的方式记录功能变得越来越有趣.

因此,我试图找到一个工具,可以在Objective C头文件中自动插入标题文档注释,但似乎找不到一个？

基本上我想要一个可以写如下的东西:

/*!
    <desc method.>
    @param parmA
        <desc of parmA>
    @param parmB
        <desc of parmB>
    @result
        <desc of result>
 */
- (CO2 *)doSomething:(typeName)parmA withSomething:(typeName)parmB;

Answer 1

我发现这个非常方便的Xcode插件可以为你编写所有默认的注释代码.

https://github.com/onevcat/VVDocumenter-Xcode

编辑

从Xcode 8开始,有一个新的快捷方式,与VVDocumenter插件具有相同的行为.

将光标放在任何函数,类,结构,...上方并点击 ? + ? + /

这将根据您放置光标的位置生成注释.