objective-c - 为已弃用的方法添加注释

Question

我有几种方法要弃用。

我用以下方法做到这一点：

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

这有效，但我如何添加消息？像“改用有条不紊的xyz”之类的东西......

谢谢

score 13 · Accepted Answer

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

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

如果你愿意，你也可以使用不那么复杂的：

__deprecated_msg("use x method")

score 5 · Accepted Answer

我倾向于使用这个：

__deprecated_msg("use method x instead")

而不是：

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

它们在引擎盖下实际上是相同的，但第一个更清楚一点。

score 1 · Accepted Answer

- 对于 SWIFT 代码：

把它放在方法的正上方： @available(*, deprecated: <#Version#>, message: <#Message#>)

例子：

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

score 0 · Accepted Answer

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

我推荐你Appledoc。它易于使用，有很好的文档记录并启用了降价样式。