如何使用headerdoc正确记录NSNotifications



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

不幸的是,Xcode中可用的头文件不包含相应的注释。

HeaderDoc用户指南显示了如何使用@group标记将项目分组在一起,并解释了类似于UIApplication文档的结果。

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

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

警告只是暂时的,因为通知本身还没有记录下来。我一开始记录通知,警告就消失了。

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

最新更新