objective-c - 在 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 插件相同。

将光标放在任何函数、类、结构...的上方，然后点击 ⌘ + ⌥ +/

这将根据您放置光标的位置生成评论。