文档自定义框架 XCode

Question

我实际上正在为 iOS / OSX 创建一个框架，我想像 apple 一样记录我的 public 方法。

例如，假设我有方法 doSomething: ... 我想在 XCode.

的自动完成窗格中收到描述 "Do something very interesting!"

这是所需结果的示例：

这可能吗？

Answer 1

可以在方法声明中添加文档注释：

/**
 * Summary of the method.
 *
 * @param firstParam This affects what the method does.
 * @param secondParam And so does this!
 *
 * @return Something very interesting.
 */

Reference.

Answer 2

如果您在代码中添加具有特定语法的注释，它将被转换为文档。

在 NSHipster 上阅读这篇文章。