【问题标题】:automatically insert header doc comments in Objective C?在Objective C中自动插入标题文档注释?
【发布时间】:2013-09-30 23:17:49
【问题描述】:

由于 XCode 5 现在支持直接从头文件中读取头 cmets,以一致的方式记录功能变得越来越有趣。

因此我试图找到一种可以在Objective C头文件中自动插入header doc cmets的工具,但似乎找不到?

基本上我想要一个可以写如下内容的镜头:

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

【问题讨论】:

    标签: objective-c xcode headerdoc


    【解决方案1】:

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

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

    编辑

    从 Xcode 8 开始,有一个新的快捷方式可用,其行为与 VVDocumenter 插件相同。

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

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

    【讨论】:

    • 似乎是完美的解决方案!但是我不能让它工作。它似乎只是简单地插入我在剪贴板中的任何内容,而不是插入评论。你成功了吗?
    • 是的,您应该下载主分支,构建 VVDocumenter-Xcode 目标,然后重新启动 Xcode。这对我有用。
    • 啊我发现我正在使用的另一个工具(剪切/粘贴文件)导致了问题。似乎是一个很好的工具!谢谢
    猜你喜欢
    • 2010-11-13
    • 2013-07-15
    • 2020-05-25
    • 2014-05-26
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    相关资源
    最近更新 更多