评论标签@code不适用于属性

时间:2015-05-07 15:52:23

标签: ios objective-c properties documentation comments

我正在为Xcode中的快速帮助功能记录我的Objective-C代码,如下所示:

enter image description here

但是我在记录属性方面遇到了一些问题:它可能使用标签 @code

因为此评论不起作用:

/** 
 the URL base for backend APIs
 @code
 codeexample;
 @endcode
*/
@property (nonatomic, strong) NSString *baseUrl;

但这有效:

/** 
 the URL base for backend APIs
*/
@property (nonatomic, strong) NSString *baseUrl;

也许 @code 标签不能与属性一起使用?或者我做错了什么?

1 个答案:

答案 0 :(得分:1)

这种文档风格不适用于属性,只适用于方法。这就是为什么@ psobko的例子有效并且你没有做到的原因。他们记录了方法定义。