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をお勧めします。使いやすく、ドキュメントが充実しており、マークダウンスタイルが有効になっています。