【问题标题】:Significance of exclamation marks in comments in iosios评论中感叹号的意义
【发布时间】:2014-01-24 07:38:54
【问题描述】:

我见过程序员使用类似以下格式的 cmets:

/*! This is a sample comment
*/

我在 ios 开发时第一次看到这样的 cmets,即在 Objective-c 中。 '!'(感叹号)在这里有什么意义?

【问题讨论】:

    标签: ios objective-c coding-style comments


    【解决方案1】:

    这是HeaderDoc的介绍标签

    您通常在“链接”到方法、函数或变量的注释中看到它。

    例如:

    /*!
     This is a comment about FunctionName.
    */
    char *FunctionName(int k);
    

    如果您在 Xcode 5.1 中使用这些 cmets,您可以为您自己的代码使用这些文档弹出框(Option + 单击方法):

    因此,希望将来能更频繁地看到这些事情。 :-)

    如果您想自己使用它们,我建议您查看VVDocumenter,这是一个 Xcode 插件,它可以让创建它们变得更容易一些。

    【讨论】:

    • 是的!我在函数声明上方看到了这一点。
    猜你喜欢
    • 2022-07-26
    • 1970-01-01
    • 1970-01-01
    • 2012-07-07
    • 2012-11-01
    • 1970-01-01
    • 2020-01-09
    • 1970-01-01
    相关资源
    最近更新 更多