Quel est le représentant du _ souligné dans Swift References?

Dans la section de référence de la documentation d'Apple, il y a beaucoup d'exemples de ce genre de chose:

func runAction(_action: SKAction!)

L'équivalent Objective-C de ceci est:

- (void)runAction:(SKAction *)action

Il me semble qu'il est probablement important (dans la référence Swift) qu'il y ait un espace après le trait de soulignement et que «action» soit écrit en italique.

Mais je ne peux pas comprendre ce que cela essaie de transmettre. Alors peut-être que la question est ... y a-t-il une référence pour les conventions utilisées dans les références?

- voici la page que je fais référence dans cette référence à l'utilisation du trait de soulignement: https://developer.apple.com/documentation/spritekit/sknode#//apple_ref/occ/instm/SKNode/runAction

Mettre à jour

Swift 3 a apporté quelques modifications à la façon dont les noms de paramètres de fonction / méthode et les étiquettes d'argument sont utilisés et nommés. Cela a des ramifications sur cette question et sa réponse. @Rickster fait un travail incroyable en répondant à une question différente sur les _underscores dans des fonctions qui efface une grande partie de cela, ici: Pourquoi ai-je besoin de soulignements dans Swift?

Les deux réponses étaient correctes, mais je veux clarifier un peu plus.

_est utilisé pour modifier le comportement des noms de paramètres externes pour les méthodes .

Dans la section Noms de paramètres locaux et externes pour les méthodes de la documentation, il est dit:

Swift donne au premier nom de paramètre dans une méthode un nom de paramètre local par défaut, et donne au deuxième nom de paramètre et aux suivants des noms de paramètres locaux et externes par défaut.

En revanche, les fonctions par défaut n'ont pas de noms de paramètres externes.

Par exemple, nous avons cette foo()méthode définie dans la classe Bar:

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

Lorsque vous appelez foo(), il est appelé comme bar.foo("Hello", s2: "World").

Mais vous pouvez remplacer ce comportement en utilisant _devant l' s2endroit où il est déclaré.

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

Ensuite, lorsque vous appelez foo, il pourrait être simplement appelé comme bar.foo("Hello", "World")sans le nom du deuxième paramètre.

Revenons à votre cas, runActionc'est une méthode parce qu'elle est associée au type SKNode, évidemment. Ainsi, mettre un _paramètre avant actionvous permet d'appeler runActionsans nom externe.

Mise à jour pour Swift 2.0

La fonction et la méthode fonctionnent désormais de la même manière en termes de déclaration de nom d'argument local et externe.

Les fonctions sont désormais appelées en utilisant le nom du paramètre externe par défaut, à partir du 2ème paramètre. Cette règle s'applique uniquement au code Swift pur.

Ainsi, en fournissant un _devant une fonction , l'appelant n'aura pas à spécifier le nom du paramètre externe, tout comme ce que vous feriez pour une méthode .

Le trait de soulignement est un jeton général utilisé pour indiquer une valeur ignorée.

Dans ce cas précis, cela signifie que la fonction sera invoquée au runAction(argument)lieu derunAction(action:argument)

Dans d'autres contextes, il a une autre signification similaire, par exemple dans:

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

Cela signifie que nous voulons simplement exécuter le bloc 5 fois et que nous ne nous soucions pas de l'index dans le bloc.

Dans ce contexte:

let (result, _) = someFunctionThatReturnsATuple()

Cela signifie que nous ne nous soucions pas de ce qu'est le deuxième élément du tuple, seulement le premier.

Depuis Swift 3, toutes les étiquettes d'argument sont requises par défaut .

Vous pouvez forcer un IDE à masquer une étiquette d'argument avec _.

func foo(a: String) {
}

func foo2(_ a: String) {
}

appelé foo(a: "abc")etfoo2("abc")

Remarque: Cela ne peut être utilisé que lorsque ale nom de l'argument (externe) et le nom de la variable (interne) sont en même temps. C'est équivalent - func foo(a a: String)n'acceptera pas le _.

Pourquoi Apple l'utilise-t-il?

Vous pouvez voir qu'Apple l'utilise dans l'API. Les bibliothèques d'Apple sont toujours écrites en Objective-C (sinon, elles partagent de toute façon les mêmes noms de fonction, qui ont été conçus pour la syntaxe Objective-C)

Des fonctions comme applicationWillResignActive(_ application: UIApplication)auraient un nom de paramètre redondantapplication , car il y a déjà l' application dans son nom de fonction.

Votre exemple

func runAction(_ action: SKAction!)serait appelé sans sa _marque comme runAction(action:). Le nom du paramètre actionserait redondant car il y en a déjà un dans le nom de la fonction. C'est le but et pourquoi il est là.

Un identifiant devant la déclaration de paramètre définit un nom de paramètre externe . C'est le nom qui doit être fourni par l'appelant lors de l'appel de la fonction:

func someFunction(externalParameterName localParameterName: Int)

Swift fournit un nom externe automatique pour tout paramètre par défaut que vous définissez, si vous ne fournissez pas vous-même un nom externe. L'utilisation d'un trait de soulignement pour le nom du paramètre externe exclut ce comportement:

Vous pouvez désactiver ce comportement en écrivant un trait de soulignement ( _) au lieu d'un nom externe explicite lorsque vous définissez le paramètre.

Vous pouvez en savoir plus sur ce comportement dans la section sur les noms externes pour les paramètres avec des valeurs par défaut ici .

Je pense que cela force une convention dans Swift qui la rend plus proche de l'objectif-c, qui correspond mieux aux conventions du cacao. Dans objc, vous ne nommez pas (en externe) votre premier paramètre. Au lieu de cela, par convention, vous incluez généralement le nom externe dans la dernière partie du nom de la méthode comme ceci:

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

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

Pour rendre les appels d'API Swift cohérents avec objc, vous souhaiterez supprimer le nom de paramètre externe du premier paramètre.

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

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

En fait, il existe une différence entre le code réel utilisé pour définir une méthode et la déclaration de méthode dans la documentation d'Apple. Prenons UIControl de - addTarget: action: forControlEvents: méthode par exemple, le code est réel:

Mais dans la documentation, cela ressemble à ceci (remarquez _ avant la cible):

Dans le code réel, _ est utilisé pour que le nom externe du deuxième paramètre ou des suivants n'apparaisse pas lorsqu'une méthode est appelée, tandis que dans la documentation, _ avant que le nom local d'un paramètre indique que lorsque vous appelez une méthode ou une fonction, vous ne devez pas fournir de nom externe.

Il n'y a pas de nom externe lorsqu'une fonction est appelée par défaut, sauf si vous fournissez le vôtre ou ajoutez le # avant (sans espace) le nom local d'un paramètre, par exemple, voici comment nous utilisons dispatch_after :

Et dans la documentation, cela ressemble à ceci (notez trois _):

La convention de déclaration de fonction est exactement la même que celle que j'ai décrite pour method.

Juste plus visuellement.

Comme vous pouvez le voir, _faites simplement omettre un nom de paramètre local ou non.