记录类方法答案

【问题标题】：Documenting Class Methods记录类方法
【发布时间】：2014-05-24 02:03:37
【问题描述】：

我不知道我是否遗漏了什么，但我怎样才能记录我的类方法？这不起作用

/*!
  Testing Description.
  @param screenName This a screen name.
  @return void
*/ 
+ (void)startScreenRecording:(NSString *)screenName;

它显然适用于常规实例方法（ - (void)...），但我实际上期待在不安装任何东西或运行任何脚本的情况下记录这一点。

【问题讨论】：

嗯。该文档对我来说很好用（Xcode 5.1.1）。
这真的很奇怪，但我意识到大多数时候不会立即出现来自类的文档。你需要花一些时间在 Xcode 中，给它一个 Clean ，有时甚至重新启动 Xcode。尝试用上面的文档声明一个类方法，如果您尝试查看文档，它不会立即显示（就像实例方法一样）。我相信这只是习惯。

标签： xcode class methods documentation

【解决方案1】：

在没有任何其他插件/应用的情况下进行了尝试，只使用了干净的 Xcode 版本 5.1.1 (5B1008) 并且它工作正常。

在@interface头文件中添加了文档。

代码

#import <Foundation/Foundation.h>

@interface Testting : NSObject

/*!
 Testing Description.
 @param screenName This a screen name.
 @return void
 */
+ (void)startScreenRecording:(NSString *)screenName;

@end

在实现文件和我导入并使用头文件的任何地方，我都可以⌥+单击并出现弹出窗口。

【讨论】：

谢谢，我相信这是一个奇怪的错误。尝试声明一个包含其文档的类方法，并尝试立即在头文件中查看相同的文档。需要一些时间才能显示出来（取决于您的项目的大小，也许？因为它重新编译了所有内容？）；但是实例类确实会立即出现。
在截图中可以看到，它是一个类方法（+ (void)...），文档在头文件我>太。它立刻就在那里。我什至没有正确编译（Build）项目。