为已弃用的方法添加注释

Question

我想要弃用几种方法。

我通过以下方式执行此操作：

+(void)myMethod:(NSString*)abc __deprecated;

这有效，但如何添加消息？像“使用methody xyz”之类的东西......

由于

Answer 1

正如尼古拉斯史密斯在评论中提到的那样。解决方案是：

__attribute((deprecated("use x method")))

如果你想要你也可以使用较少复杂的：

__deprecated_msg("use x method")

Answer 2

我倾向于使用它：

__deprecated_msg("use method x instead")

而不是：

__attribute((deprecated("use method x instead")))

它们在引擎盖下真的是一样的，但第一个更清晰。

Answer 3

我认为您需要使用文档生成器：Doxygen，Headerdoc等

我建议你Appledoc。它易于使用，记录良好，并且启用了降价样式。

Answer 4

-用于SWIFT代码：

将此放在方法上方： @available(*, deprecated: <#Version#>, message: <#Message#>)

示例：

@available(*, deprecated: 11, message: "Use color assets instead")
public struct ColorPaletteItemResource: ColorPaletteItemResourceType {
    ...
}