¿Cuál es el representante de subrayado _ en las referencias de Swift?

En la sección de referencia de los documentos de Apple hay muchas instancias de este tipo de cosas:

func runAction(_action: SKAction!)

El 'equivalente' del objetivo C de esto es:

- (void)runAction:(SKAction *)action

Me sorprende que probablemente sea importante que (en la referencia de Swift) haya un espacio después del guión bajo y la "acción" esté escrita en cursiva.

Pero no puedo entender lo que esto está tratando de transmitir. Entonces, tal vez la pregunta es ... ¿hay alguna referencia para las convenciones utilizadas en las referencias?

- Aquí está la página a la que me refiero en esta referencia para el uso de subrayado: https://developer.apple.com/documentation/spritekit/sknode#//apple_ref/occ/instm/SKNode/runAction

Actualizar

Swift 3 ha realizado algunos cambios en cómo se usan y nombran los nombres de parámetros de función / método y las etiquetas de argumento. Esto tiene ramificaciones en esta pregunta y su respuesta. @Rickster hace un trabajo increíble al responder una pregunta diferente sobre _coincidencia en funciones que aclara gran parte de esto, aquí: ¿Por qué necesito guiones bajos rápidamente?

Ambas respuestas fueron correctas, pero quiero aclarar un poco más.

_se utiliza para modificar el comportamiento del nombre del parámetro externo para los métodos .

En la sección Nombres de parámetros locales y externos para métodos de la documentación, dice:

Swift le da al primer nombre de parámetro en un método un nombre de parámetro local de manera predeterminada, y le da al segundo nombre y a los nombres de parámetro posteriores nombres de parámetro locales y externos de manera predeterminada.

Por otro lado, las funciones por defecto no tienen nombres de parámetros externos.

Por ejemplo, tenemos este foo()método definido en la clase Bar:

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

Cuando llamas foo(), se llama como bar.foo("Hello", s2: "World").

Pero , puede anular este comportamiento al usarlo _delante de s2donde se declara.

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

Luego, cuando llame foo, podría simplemente llamarse como bar.foo("Hello", "World")sin el nombre del segundo parámetro.

Volviendo a su caso, runActiones un método porque está asociado con el tipo SKNode, obviamente. Por lo tanto, poner un _parámetro antes le actionpermite llamar runActionsin un nombre externo.

Actualización para Swift 2.0

La función y el método ahora funcionan de la misma manera en términos de declaración de nombre de argumento local y externo.

Las funciones ahora se invocan utilizando el nombre del parámetro externo de forma predeterminada, comenzando en el segundo parámetro. Esta regla solo se aplica al código Swift puro.

Entonces, al proporcionar un _frente a una función , la persona que llama no tendrá que especificar el nombre del parámetro externo, al igual que lo que haría para un método .

El guión bajo es un token general utilizado para indicar un valor descartado.

En este caso específico, significa que la función se invocará como en runAction(argument)lugar derunAction(action:argument)

En otros contextos tiene otro significado similar, por ejemplo, en:

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

Significa que simplemente queremos ejecutar el bloque 5 veces y no nos importa el índice dentro del bloque.

En este contexto:

let (result, _) = someFunctionThatReturnsATuple()

Significa que no nos importa cuál es el segundo elemento de la tupla, solo el primero.

Desde Swift 3, todas las etiquetas de argumentos son necesarias de forma predeterminada .

Puede forzar un IDE para ocultar una etiqueta de argumento _.

func foo(a: String) {
}

func foo2(_ a: String) {
}

llamado foo(a: "abc")yfoo2("abc")

Nota: Esto solo se puede usar cuando aes la etiqueta del argumento (externo) y el nombre de la variable (interna) al mismo tiempo. Es equivalente func foo(a a: String), no acepta el _.

¿Por qué lo está usando Apple?

Puedes ver que Apple lo está utilizando en toda la API. Las bibliotecas de Apple todavía están escritas en Objective-C (de lo contrario, comparten los mismos nombres de función de todos modos, que fueron diseñados para la sintaxis de Objective-C)

Funciones como applicationWillResignActive(_ application: UIApplication)tendrían un nombre de parámetro redundanteapplication , ya que ya existe la aplicación en su nombre de función.

Su ejemplo

func runAction(_ action: SKAction!)se llamaría sin su _marca como runAction(action:). El nombre del parámetro actionsería redundante ya que ya hay uno en el nombre de la función. Ese es el propósito y por qué está ahí.

Un identificador delante de la declaración de parámetro define un nombre de parámetro externo . Este es el nombre que debe proporcionar la persona que llama al llamar a la función:

func someFunction(externalParameterName localParameterName: Int)

Swift proporciona un nombre externo automático para cualquier parámetro predeterminado que defina, si no proporciona un nombre externo usted mismo. El uso de un guión bajo para el nombre del parámetro externo se excluye de este comportamiento:

Puede optar por este comportamiento escribiendo un guión bajo ( _) en lugar de un nombre externo explícito cuando defina el parámetro.

Puede leer más sobre este comportamiento en la sección de Nombres externos para parámetros con valores predeterminados aquí .

Creo que esto obliga a una convención en Swift que lo hace leer más cerca del objetivo-c, que coincide mejor con las convenciones del cacao. En objc no nombra (externamente) su primer parámetro. En cambio, por convención, generalmente incluye el nombre externo en la última parte del nombre del método de esta manera:

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

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

Para hacer que las llamadas a la API de Swift sean coherentes con objc, deberá suprimir el nombre del parámetro externo del primer parámetro.

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

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

En realidad, hay una diferencia entre el código real utilizado para definir un método y la declaración del método en los documentos de Apple. Tomemos UIControl 's - addTarget: action: forControlEvents: método por ejemplo, el código real es:

Pero en documentos, aparece así (aviso _ antes del objetivo):

En el código real, _ se utiliza para hacer que el nombre externo del segundo parámetro o posterior no aparezca cuando se llama a un método, mientras que en documentos, _ antes del nombre local de un parámetro indica que cuando se llama a un método o una función, no debe proporcionar un nombre externo

No hay un nombre externo cuando se llama a una función de manera predeterminada a menos que proporcione el suyo propio o agregue # antes (sin espacios en blanco) el nombre local de un parámetro, por ejemplo, así es como utilizamos dispatch_after :

Y en documentos, aparece así (nota tres _):

La convención de la declaración de la función es la misma que he descrito para el método.

Solo más visualmente.

Como puede ver, _simplemente omita un nombre de parámetro local o no.