xCode的评论样式

Question

如何在类中为公共方法和属性编写（样式）注释，以便它们在“快速帮助”窗口中以与内置方法相同的方式显示？

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

THX

Answer 1

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

  

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

Appledoc似乎是您最好的选择。我知道这不是你正在寻找的答案，但它似乎并不太糟糕。