【问题标题】:How to document NSNotifications properly with headerdoc?如何使用 headerdoc 正确记录 NSNotifications?
【发布时间】:2014-03-14 22:54:15
【问题描述】:

UIApplication 的文档包含一个 Notification 部分,其中列出了所有相关的 NSNotifications。

很遗憾,Xcode 中可用的头文件不包含相应的 cmets。

HeaderDoc User Guide 展示了如何使用@group 标记将项目组合在一起,解释了类似于UIApplication 文档的结果。

分组标签允许您将函数、方法和变量组织到集合中。在 HTML 输出模式中,目录(左列)被组织成这些组。此外,正文内容(右侧)包含每个组的文档。该文档块包含该组的名称、讨论以及该组中包含的任何函数、数据类型或变量的列表,以及它们的摘要。

但是,当我尝试使用 @group 标记时,我收到警告 Unknown command tag name,并且 @group 标记没有以深绿色突出显示,使得 Xcode 似乎无法识别它。

【问题讨论】:

    标签: objective-c xcode documentation nsnotification headerdoc


    【解决方案1】:

    警告只是暂时的,因为通知本身尚未记录在案。一旦我开始记录通知,警告就消失了。

    但是,Xcode 仍然没有像其他 headerdoc 标记那样以深绿色显示 group 标记。

    【讨论】:

      猜你喜欢
      • 1970-01-01
      • 2014-08-25
      • 1970-01-01
      • 1970-01-01
      • 2011-11-13
      • 1970-01-01
      • 2011-12-24
      • 2015-01-28
      • 2011-05-22
      相关资源
      最近更新 更多