不确定我是否使用了最佳标题,但这是我能想到的最好的。 对于我们这些对XCode很新的人,以及在Visual Studio中过度纵容的人,我真的很想念Visual Studio中的功能,我可以使用XML来展示我的代码元素(属性,函数,类等等)在intellisense中,当用户试图在他们的代码中使用我的类库时,他们可以在他们的代码窗口中键入我的一个方法的名称,并且下拉列表不仅包括参数info(XCode所做的),但是它还包括我为方法提供的任何其他补充信息,以便传达摘要描述或其他细节,这些信息可能单独从方法/属性/委托/等名称中显而易见。
这在XCode中是否可行?我假设没有,因为我还没有看到它完成。
答案 0 :(得分:2)
你可以在Xcode中完成。
在您的类名/方法声明/属性声明之前的行中,并始终在标题(.h)文件中,您应该包含文档注释(包含/// comment
或/** comment **/
)。每当您键入该对象/方法/属性的名称时,此文本将在Xcode下拉菜单中可见。
示例:
/// This string contains a certain text.
@property (nonatomic, strong) NSString *string;
或
/** This object subclasses UIView to achieve something. **/
@interface MyView : UIView {
...
答案 1 :(得分:2)
从Xcode 5开始,您可以记录您的方法,Xcode将以与Apple自己相同的方式阅读该文档。
示例...
/**
* Does foo things with bar stuff.
*
* @param bar stuff.
*/
- (void)foo:(id)bar;
结果......
我还建议使用名为VVDocumenter的Xcode插件来更快地记录您的方法。