注释标记@code 不适用于属性

Question

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

但是我在记录属性时遇到了一个小问题：可以使用标签 @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标签不能和属性一起使用？还是我做错了什么？

Answer 1

这种文档风格不适用于属性，仅适用于方法。这就是为什么@psobko 的示例有效而您的示例无效的原因。他们记录了一个方法定义。

Comment tag @code doesn't work with properties