如何在 iOS Objective-C 头文件中将函数标记为已弃用？

Question

如何在 iOS Objective-C 头文件中将函数标记为已弃用？

我猜我可以在函数后面的某个地方粘贴一些关键字？

我希望如果任何人尝试使用已弃用的函数，都会生成编译器警告，类似于 Apple 的 API 中看到的行为。

Answer 1

尝试在方法声明中附加一个属性：

- (void)fooBar __attribute__ ((deprecated));

取自此处 。

Answer 2

您可以使用 中定义的宏来代替 __attribute__((deprecated))：

- (void)fooBar __deprecated;
// Or better:
- (void)fooBar __deprecated_msg("Use barFoo instead.");

或者您可以使用 < 中定义的宏;AvailabilityMacros.h>：

- (void)fooBar DEPRECATED_ATTRIBUTE;
// Or better:
- (void)fooBar DEPRECATED_MSG_ATTRIBUTE("Use barFoo instead.");

如果您使用 Objective-C，则没有什么区别，因为您将使用现代编译器，因此您可以使用 Apple 短语法 __deprecated_msg()。但如果您使用 C 实现跨平台，则 DEPRECATED_MSG_ATTRIBUTE() 使用最佳可用性定义（例如，它支持 GCC3.1）。

Answer 3

蒂姆的回答实际上会产生编译器警告；其他版本只是注释，对编译器没有任何影响。

如果您查看 /usr/include/AvailabilityMacros.h，您将了解 Apple 是如何做到这一点的。该标头使用 __attribute__((deprecated)) 和 __attribute__((unavailable))，具体取决于 API 是否存在但已弃用，或者实际上已从操作系统中删除。

Answer 4

来自 Apple 的 SFAuthorization.h：

/*!
DEPRECATED: Use obtainWithRight:flags:error:
@method permitWithRight:flags:
@abstract Call permitWithRight to gain a right to have
          access to a privilege operation.
@param rightName The name of an authorization right.
@param flags Authorization flags.
*/
- (OSStatus)permitWithRight:(AuthorizationString)rightName
                      flags:(AuthorizationFlags)flags;

如果您没有使用自动文档生成器，我会说这样就足够了：

- (void)doSomething;           /* DEPRECATED */

Answer 5

您还可以按照 HeaderDoc 手册。使用此语法的地方：

/*!
 * @abstract Foo is good for bar.
 *
 * @deprecated in version 2.0
 */