为已弃用的方法添加注释答案

【问题标题】：adding comment to deprecated method为已弃用的方法添加注释
【发布时间】：2013-03-07 21:05:15
【问题描述】：

我有几个要弃用的方法。

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

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

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

谢谢

【问题讨论】：

添加 headerdoc 怎么样？
stackoverflow.com/questions/4924285/… 根据您使用的答案的第三条评论__attribute((deprecated(use x method)))
试过了，但是在“使用”之后我在空格处出现错误。 Xcode 说“预期）”
我的错，我应该跟进答案，而不是仅仅链接它，在 clang 语言扩展指南 (clang.llvm.org/docs/…) 中它说消息必须在 "" 内。
就这么简单吧head:desk :) 把它变成一个答案，这样我就可以批准了。

【解决方案1】：

正如 Nicholas Smith 在 cmets 中提到的那样。解决办法是：

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

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

__deprecated_msg("use x method")

【讨论】：

【解决方案2】：

我倾向于使用这个：

__deprecated_msg("use method x instead")

而不是：

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

它们实际上是相同的，但第一个更清楚一点。

【讨论】：

【解决方案3】：

- 对于 SWIFT 代码：

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

示例：

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

【讨论】：

【解决方案4】：

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

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

【讨论】：