Wie kennzeichne ich eine Funktion als veraltet in einer iOS Objective-C-Header-Datei?

Question

Wie kennzeichne ich eine Funktion als veraltet in einer iOS Objective-C-Header-Datei?

Ich vermute, es ist nur ein Schlüsselwort, das ich nach der Funktion irgendwo einfügen kann?

Ich möchte, dass eine Compiler-Warnung generiert wird, wenn jemand versucht, die veraltete Funktion zu verwenden, ähnlich dem Verhalten in Apples APIs.

Answer 1

Versuchen Sie, ein Attribut an Ihre Methodendeklaration anzuhängen:

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

Entnommen aus ici .

Answer 2

Anstelle von __attribute__((deprecated)) können Sie die Makros verwenden, die in <cdefs.h> :

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

Oder Sie können die Makros verwenden, die in <AvailabilityMacros.h> :

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

Wenn Sie Objective-C verwenden, macht das keinen Unterschied, da Sie einen modernen Compiler verwenden werden, so dass Sie die kurze Apple-Syntax verwenden können. __deprecated_msg() . Wenn Sie jedoch C für plattformübergreifende Anwendungen verwenden, dann DEPRECATED_MSG_ATTRIBUTE() verwendet die optimalen Verfügbarkeitsdefinitionen (zum Beispiel unterstützt es GCC3.1).

Answer 3

Die Antwort von Tim führt tatsächlich zu einer Compiler-Warnung; die anderen Versionen sind lediglich Kommentare, die keine Auswirkungen auf den Compiler haben.

Wenn Sie sich /usr/include/AvailabilityMacros.h ansehen, werden Sie sehen, wie Apple dies tut. Dieser Header verwendet __attribute__((deprecated)) y __attribute__((unavailable)) je nachdem, ob die API zwar vorhanden, aber veraltet ist oder ob sie tatsächlich aus dem Betriebssystem entfernt wurde.

Answer 4

Aus Apples 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;

Wenn Sie keine automatische Dokumentationserstellung verwenden, würde ich sagen, dass so etwas ausreichend ist:

- (void)doSomething;           /* DEPRECATED */

Answer 5

Sie können auch die HeaderDoc Handbuch . Wo diese Syntax verwendet wird:

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