Wofür steht der _ Unterstrich in Swift References?

Im Referenzabschnitt der Apple-Dokumente finden Sie viele Beispiele für solche Dinge:

func runAction(_action: SKAction!)

Das Objective-C-Äquivalent dazu ist:

- (void)runAction:(SKAction *)action

Es fällt mir auf, dass es wahrscheinlich wichtig ist, dass (in der Swift-Referenz) nach dem Unterstrich ein Leerzeichen steht und "Aktion" kursiv geschrieben ist.

Aber ich kann nicht herausfinden, was dies zu vermitteln versucht. Vielleicht ist die Frage ... gibt es eine Referenz für die Konventionen, die in den Referenzen verwendet werden?

- Hier ist die Seite, auf die ich in diesem Verweis auf die Verwendung des Unterstrichs verweise: https://developer.apple.com/documentation/spritekit/sknode#//apple_ref/occ/instm/SKNode/runAction

Aktualisieren

Swift 3 hat einige Änderungen an der Verwendung und Benennung von Funktions- / Methodenparameternamen und Argumentbezeichnungen vorgenommen. Dies hat Konsequenzen für diese Frage und ihre Antwort. @Rickster beantwortet auf erstaunliche Weise eine andere Frage zu _underscores in Funktionen, die viel davon klären. Hier: Warum brauche ich schnell Unterstriche?

Beide Antworten waren richtig, aber ich möchte etwas mehr klarstellen.

_wird verwendet, um das Verhalten externer Parameternamen für Methoden zu ändern .

Im Abschnitt Lokale und externe Parameternamen für Methoden der Dokumentation heißt es:

Swift gibt dem ersten Parameternamen in einer Methode standardmäßig einen lokalen Parameternamen und dem zweiten und den nachfolgenden Parameternamen standardmäßig sowohl lokale als auch externe Parameternamen .

Andererseits haben Funktionen standardmäßig keine externen Parameternamen.

Zum Beispiel haben wir diese foo()Methode in der Klasse definiert Bar:

class Bar{
    func foo(s1: String, s2: String) -> String {
        return s1 + s2;
    }
}

Wenn Sie anrufen foo(), heißt es wie bar.foo("Hello", s2: "World").

Aber , können Sie dieses Verhalten außer Kraft setzen , indem Sie _vor , s2wo es erklärt.

func foo(s1: String, _ s2: String) -> String{
    return s1 + s2;
}

Wenn Sie dann aufrufen foo, kann es einfach wie bar.foo("Hello", "World")ohne den Namen des zweiten Parameters aufgerufen werden.

Zurück zu Ihrem Fall, runActionist eine Methode, weil sie SKNodeoffensichtlich mit dem Typ verbunden ist. Wenn Sie also einen _before-Parameter actioneingeben, können Sie runActionohne externen Namen aufrufen .

Update für Swift 2.0

Funktion und Methode funktionieren jetzt in Bezug auf die Deklaration lokaler und externer Argumentnamen auf dieselbe Weise .

Funktionen werden jetzt standardmäßig mit einem externen Parameternamen aufgerufen, beginnend mit dem 2. Parameter. Diese Regel gilt nur für reinen Swift-Code.

Wenn Sie also _eine Funktion vor einer Funktion bereitstellen , muss der Aufrufer keinen externen Parameternamen angeben, wie Sie es für eine Methode tun würden .

Der Unterstrich ist ein allgemeines Token, mit dem ein verworfener Wert angegeben wird.

In diesem speziellen Fall bedeutet dies, dass die Funktion als runAction(argument)statt aufgerufen wirdrunAction(action:argument)

In anderen Zusammenhängen hat es eine andere ähnliche Bedeutung, z. B.:

for _ in 0..<5 { ... }

Dies bedeutet, dass wir den Block lediglich fünfmal ausführen möchten und uns nicht um den Index innerhalb des Blocks kümmern.

In diesem Kontext:

let (result, _) = someFunctionThatReturnsATuple()

Es bedeutet, dass es uns egal ist, was das zweite Element des Tupels ist, nur das erste.

Seit Swift 3 sind standardmäßig alle Argumentbezeichnungen erforderlich .

Sie können eine IDE zwingen, eine Argumentbezeichnung mit auszublenden _.

func foo(a: String) {
}

func foo2(_ a: String) {
}

genannt foo(a: "abc")undfoo2("abc")

Hinweis: Dies kann nur verwendet werden, wenn gleichzeitig adie (externe) Argumentbezeichnung und der (interne) Variablenname angegeben sind . Es ist gleichwertig - func foo(a a: String)wird das nicht akzeptieren _.

Warum verwendet Apple es?

Sie können sehen, dass Apple es über die API verwendet. Apples Bibliotheken sind immer noch in Objective-C geschrieben (wenn nicht, haben sie ohnehin dieselben Funktionsnamen, die für die Objective-C-Syntax entwickelt wurden).

Funktionen wie applicationWillResignActive(_ application: UIApplication)hätten einen redundanten Parameternamen application, da die Anwendung bereits im Funktionsnamen enthalten ist.

Dein Beispiel

func runAction(_ action: SKAction!)würde aufgerufen werden , ohne es der _Marke wie runAction(action:). Der Parametername actionwäre redundant, da der Funktionsname bereits einen enthält. Das ist der Zweck und warum es da ist.

Ein Bezeichner vor der Parameterdeklaration definiert einen externen Parameternamen. Dies ist der Name, den der Aufrufer beim Aufrufen der Funktion angeben muss:

func someFunction(externalParameterName localParameterName: Int)

Swift stellt einen automatischen externen Namen für jeden von Ihnen definierten Standardparameter bereit, wenn Sie selbst keinen externen Namen angeben. Wenn Sie einen Unterstrich für den externen Parameternamen verwenden, wird dieses Verhalten nicht berücksichtigt:

Sie können dieses Verhalten deaktivieren, _indem Sie beim Definieren des Parameters einen Unterstrich ( ) anstelle eines expliziten externen Namens schreiben .

Weitere Informationen zu diesem Verhalten finden Sie im Abschnitt Externe Namen für Parameter mit Standardwerten hier .

Ich denke, dies erzwingt eine Konvention in Swift, die es näher an Ziel-c bringt, was besser zu Kakaokonventionen passt. In objc benennen Sie Ihren ersten Parameter nicht (extern). Stattdessen fügen Sie gemäß Konvention normalerweise den externen Namen wie folgt in den letzten Teil des Methodennamens ein:

- (void)myFancyMethodWithFirstName:(NSString *)aFirstName lastName:(NSString *)aLastName;

[someInstance myFancyMethodWithFirstName:@"John" lastName:@"Doe"];

Um Swift-API-Aufrufe mit objc konsistent zu machen, sollten Sie den externen Parameternamen des ersten Parameters unterdrücken.

func myFancyMethodWithFirstName(_ firstName:String, lastName:String);

someInstance.myFancyMethodWithFirstName("John", lastName:"Doe")

Tatsächlich gibt es einen Unterschied zwischen dem tatsächlichen Code, der zum Definieren einer Methode verwendet wird, und der Methodendeklaration in Apples Dokumenten. Nehmen wir UIControl ‚s - addTarget: Aktion: forControlEvents: Verfahren zum Beispiel die echten Code ist:

In Dokumenten sieht es jedoch so aus (Hinweis _ vor dem Ziel):

Im realen Code wird _ verwendet, um den externen Namen des zweiten oder nachfolgenden Parameters beim Aufrufen einer Methode nicht anzuzeigen , während in docs _ vor dem lokalen Namen eines Parameters angegeben wird, dass Sie beim Aufrufen einer Methode oder einer Funktion keine angeben sollten externer Name.

Es gibt keinen externen Namen, wenn eine Funktion standardmäßig aufgerufen wird, es sei denn, Sie geben Ihren eigenen Namen an oder fügen # vor (ohne Leerzeichen) dem lokalen Namen eines Parameters hinzu. So verwenden wir beispielsweise dispatch_after :

Und in Dokumenten sieht es so aus (beachten Sie drei _):

Die Konvention der Funktionsdeklaration ist genau die gleiche, die ich für die Methode beschrieben habe.

Nur optisch.

Wie Sie sehen können, lassen Sie _einfach einen lokalen Parameternamen weg oder nicht.