ios - xCode 的注释样式

Question

我应该如何在我的类中为公共方法和属性编写（什么风格）注释，以便它们在快速帮助窗口中可见，就像它们在内置方法中一样？

iOS 中缺少强类型数组给我带来了很多问题，尤其是当一个方法接受 NSArray* 时，如果我是在 6 个月前编写的，那么我需要确保进入该方法并检查必须的实际类型是什么存储在该数组中。

谢谢

Answer 1

是的，您必须在需要更改时重新生成文档。Xcode 不会像 Visual Studio 那样根据您的评论即时获取文档。我链接到的问题中的评论证实了这一点：

Xcode 的快速帮助使用您安装的文档集来显示其内容。除非您为类创建和安装文档集，否则所有快速帮助显示都是指向您声明类、方法或数据成员的头文件的链接。

Appledoc 似乎是您最好的选择。我知道这不是您要寻找的答案，但似乎还不错。