Tutoriel pour apprendre le nommage des paramètres pour les applications Objectif-C ou Swift

Mathilde Roussel

Que ce soit il y a plusieurs années ou aujourd'hui, Apple, au travers du langage Swift et Objective-C, a toujours proposé une syntaxe particulière aux développeurs.
Avec Swift, les développeurs ont découvert une syntaxe plus lisible et moderne, même si celle-ci garde certains aspects de son grand frère, l'Objective-C.
C'est notamment le cas pour le nommage des paramètres, qui a toujours suscité la curiosité ou l'appréhension chez ceux qui se frottent à ces deux langages. Nous verrons comment cette pierre angulaire dans le développement d'applications Apple a évolué et quel sera son avenir prochain.

Commentez

- Titre : Tutoriel pour apprendre le nommage des paramètres pour les applications Objectif-C ou Swift

- Auteur : Mathilde Roussel

- Parution : 2 mars 2017

- Licence : Les sources présentées sur cette page sont libres de droits et vous pouvez les utiliser à votre convenance. Par contre, la page de présentation constitue une œuvre intellectuelle protégée par les droits d'auteur. Copyright ® 2017 Mathilde Roussel. Aucune reproduction, même partielle, ne peut être faite de ce site et de l'ensemble de son contenu : textes, documents, images, etc. sans l'autorisation expresse de l'auteur. Sinon vous encourez selon la loi jusqu'à trois ans de prison et jusqu'à 300 000 € de dommages et intérêts.

Sommaire

- I. Parlons des avantages de cette convention

- II. Objective-C pose les bases

- III. Apple fait peau neuve avec Swift, mais s'inspire d'Objective-C

- III-A. Le cas des constructeurs

- III-B. Les paramètres externes

- IV. Swift 2.2 et Swift 3.0 : il est temps de revoir le nommage des paramètres

- IV-A. Le choix des noms des paramètres est plus permissif

- IV-B. Disparition du mot-clé var dans les paramètres

- IV-C. L'utilisation des paramètres externes dans les API Guidelines (Swift 3.0)

- IV-D. Le nom du premier paramètre d'une méthode devient obligatoire (Swift 3.0)

- V. Conclusion

- VI. Remerciements

I - Parlons des avantages de cette convention

Si Objective-C est un langage réputé comme très verbeux et difficile à lire pour les développeurs, il n'a pas apporté que des points négatifs, loin de là. Je pense être plutôt exacte en affirmant qu'une grande partie des développeurs avec un peu d'expérience dans le langage Objective-C a apprécié, après un temps d'adaptation certes, la verbosité des noms de méthodes, ainsi que le nommage des paramètres.

On entend souvent dire de la part des grands détracteurs d'Objective-C (ce qui est un peu moins vrai avec Swift aujourd'hui) que le nommage des paramètres lors de l'appel d'une méthode est inutile et redondant : selon eux, une variable doit porter un nom assez explicite pour que le code soit compris facilement à la lecture. Loin d'être en désaccord avec cette logique, j'apprécie tout de même davantage lire un appel d'une méthode où je sais exactement à quoi va servir chaque paramètre, surtout dans une méthode qui en contient un certain nombre.

Par exemple, l'utilisation des paramètres nommés s'avère très intéressante dans le cas d'une méthode qui va permettre d'ajouter un élément dans un tableau à un index précis :

[legoBricks insertObject: redBrick atIndex: 3];

Littéralement (sans s'occuper de la valeur des paramètres), on pourra lire cette méthode de cette manière : insertObject:atIndex:. On identifie directement les paramètres (un objet et un index) ainsi que leur rôle dans la méthode, sans avoir besoin de faire appel à l'aide pour voir la signature de la méthode à chaque fois.

Reste le sujet délicat de trouver un nom de paramètre pertinent, qui ait un sens à la fois à l'intérieur de la fonction qui l'utilisera, mais aussi lorsqu'elle sera appelée, mais nous verrons ça un peu plus tard.

En bref, retenons, pour la suite de l'article, que le nommage de paramètres tel que le propose Apple ne doit pas être considéré comme un défaut en termes de développement, mais comme une manière différente (et moins ambigüe) de lire les méthodes.

II - Objective-C pose les bases

Comme rappelé dans le paragraphe précédent, Objective-C, en parallèle de ses défauts, prenait déjà le parti du nommage explicite de paramètres, comme le faisait le langage dont il s'inspire, le SmallTalk.
Concrètement, la définition d'une méthode ressemble à cela :

1. @interface LegoAstronaut: NSObject

2. /* déclaration de méthode */

3. - (void)buildSpaceshipWithHeight:(int) height andWidth:(int) width;

4. @end

6. @implementation LegoAstronaut

7. - (void)buildSpaceshipWithHeight:(int) height andWidth:(int) width {

8. //code

9. }

10. @end

Ici, outre la syntaxe peu habituelle pour un développeur C# ou Java par exemple, on remarque que le premier paramètre aura pour nom height, et… Attendez, le deuxième paramètre porte le nom andWidth ou width ? Eh bien tout dépend de quel côté nous nous plaçons. À l'intérieur de la méthode, ce sera sous le nom width que le paramètre sera utilisé.
En revanche, pour appeler la méthode buildSpaceshipWithHeight:andWidth:, il faudra donner à ce paramètre le nom andWidth. Cette dernière phrase étant certainement un peu floue, voici un exemple d'appel de la méthode buildSpaceship :

1. LegoAstronaut *benny = [[LegoAstronaut alloc] init];

2. [benny buildSpaceshipWithHeight: 12 andWidth: 42];

Encore une fois, mis à part les crochets et autres particularités liées au langage (qui ne sont pas le sujet de ce tutoriel), on remarque que lors de l'appel de la méthode buildSpaceshipWithHeight:andWidth:, le deuxième paramètre est appelé andWidth. Cela permet de lire et comprendre ce que fait la méthode de manière fluide, comme si on lisait une phrase.

Quant au premier paramètre, on ne peut pas vraiment dire qu'il porte un nom extérieur. En Objective-C, on va généralement compléter le verbe au début de la signature avec with…, from… ou by… par exemple. Dans notre cas, on retrouve withHeight: juste avant l'insertion du premier paramètre.

Finalement, pour revenir à la structure de la signature d'une méthode, chaque paramètre (sauf le premier) aura un nom local, utilisé dans le corps de la méthode, et un nom externe, qui sera concerné lors de l'appel.

Cette façon de faire n'est tout de même pas très pratique, et c'est en partie à cause de cela que l'Objective-C a la réputation d'avoir des noms de méthodes à rallonge. Mais c'est un fait auquel les développeurs ont dû s'accoutumer, car, jusqu'à présent, Apple ne souhaitait pas changer cette convention.

III - Apple fait peau neuve avec Swift, mais s'inspire d'Objective-C

En juin 2014, Apple annonçait la sortie du langage Swift, une alternative moderne et developer friendly, qui vise à remplacer à terme Objective-C, qui est aujourd'hui moins adapté aux besoins et considéré comme un peu vieux, car trop proche du C.

Sans revenir en détail sur le sujet, Swift se rapproche beaucoup de langages largement utilisés aujourd'hui et en vogue, comme C#, Ruby ou Python. Cela dit, même s'il se revendique moderne, Swift garde certaines habitudes et conventions de son grand frère, et c'est justement le cas pour le nommage des paramètres.
Il faut cependant souligner que, bien qu'avec ce nouveau langage Apple conserve le nommage explicite des paramètres, on trouve tout de même un certain nombre de différences :

- les paramètres du constructeur d'une classe doivent tous être nommés au moment de l'instanciation ;

- l'utilisation du nom externe du paramètre devient optionnelle.

III-A - Le cas des constructeurs

Contrairement à l'appel d'une méthode, lors de l'instanciation d'un objet, que cela soit pour une classe créée par le développeur ou une classe déjà présente dans Swift, tous les noms de paramètres devront apparaître dans l'appel. Ces paramètres sont considérés comme des noms de paramètres externes, ce qui explique l'obligation de tous les nommer. Malgré cette appellation d'externe, il faut les différencier des noms externes pour les méthodes classiques. Mais plutôt que d'étendre ces explications peu concrètes, voici ci-dessous un exemple de classe avec son instanciation :

1. class LegoBuilder {

2. let name: String

3. let isMasterBuilder: Bool

5. init(name: String, isMasterBuilder: Bool) {

6. self.name = name

7. self.isMasterBuilder = isMasterBuilder

8. }

9. }

11. LegoBuilder(name: "Emmet", isMasterBuilder: true)

Sans surprise, on retrouve bien les deux paramètres name et isMasterBuilder définis explicitement dans le constructeur. Finalement, cela rajoute un peu de confusion par rapport à ce qu'on avait l'habitude de voir avec Objective-C, mais (teaser) fort heureusement cela va bientôt changer.
Tout de même, pour ne pas que le développeur s'emmêle les pinceaux, XCode fournit un coup de pouce en autocomplétant le code en fonction du cas dans lequel on est.

III-B - Les paramètres externes

Pour le cas des paramètres externes, avec Swift Apple a rendu la distinction entre le nom du paramètre interne et externe optionnelle : le paramètre devra toujours être nommé, mais le développeur n'est plus obligé d'avoir un nom de paramètre externe et interne, car le nom du paramètre pourra être utilisé pour l'appel et également à l'intérieur de la fonction. L'appellation des noms internes et externes est en quelque sorte fusionnée. On se retrouve ainsi avec une utilisation telle que présentée ci-dessous :

1. func sayHelloTo(name: String, repeat: Int) {

2. for _ in 1...repeat {

3. print("Hello \(name)")

4. }

5. }

7. sayHelloTo("Mathilde", repeat: 3)

On note, dans cet exemple, que le nom de paramètre repeat est à la fois dans l'appel et à l'intérieur de la méthode, mais aussi que Swift hérite de principes de son prédécesseur puisque le premier paramètre n'est pas nommé. Il est toujours explicité grâce au nom de la méthode.

Cependant, si l'utilisation des noms externes de paramètres tels qu'on le connaissait en Objective-C n'est plus obligatoire, elle reste utile selon le cas.
La documentation de Swift propose cet intérêt aux noms externes :

“The use of external parameter names can allow a function to be called in an expressive, sentence-like manner, while still providing a function body that is readable and clear in intent.”

On peut, par exemple, vouloir utiliser un nom externe pour le premier paramètre d'une méthode, si on ne supporte vraiment pas l'absence de nom pour celui-ci lors d'un appel.

1. func sayHelloTo(name name: String)

2. {

3. print("Hello  \(name) !")

4. }

5. sayHelloTo(name: "Mathilde")

Ici, le nom du paramètre est doublé, mais garde le même nom, car il est clair à la fois pour l'appel et à l'intérieur, mais, dans d'autres cas, on peut vouloir utiliser un autre nom afin d'apporter un peu plus de lisibilité :

1. func sayHelloTo(name: String, repeat iterations: Int) {

2. for _ in 1...iterations {

3. print("Hello \(name)")

4. }

5. }

7. sayHelloTo("Mathilde", repeat: 3)

Dans le cas contraire, si on souhaite omettre un nom externe, par exemple dans un constructeur, on peut le surcharger avec un underscore :

1. class Point

2. {

3. let x: Int

4. let y: Int

6. init(_ x: Int, _ y: Int)

7. {

8. self.x = x

9. self.y = y

10. }

11. }

13. Point(0,0)

On se rapproche dans ce cas de la syntaxe du C# et du Java, ce qui peut être un avantage pour débuter, bien que le nommage explicite des paramètres soit très guidé par l'autocomplétion dans XCode et le compilateur.

Swift, même si le langage est encore très jeune, bouscule beaucoup de choses. Il est en effet open source depuis décembre 2015 et, avec les changements que cela implique, la communauté est mise à contribution pour décider (du moins en partie) de l'avenir de Swift. Et il y a un rapport direct avec le sujet de ce tutoriel, que nous allons voir tout de suite.

IV - Swift 2.2 et Swift 3.0 : il est temps de revoir le nommage des paramètres

Avec l'arrivée (toute fraîche) de Swift 2.2 et les précisions concernant la version 3.0, Apple a communiqué sur nombre de changements qui vont avoir lieu dans le langage. Pour la version 2.2, quelques modifications sont apportées, mais sans grand impact. C'est dans la version 3.0 qu'apparaîtra un point très demandé et donc attendu. Voyons tout cela en détail.

IV-A - Le choix des noms des paramètres est plus permissif

Plus de noms de paramètres peuvent être utilisés : pour la version 2.2 de Swift, Apple rend possible l'utilisation de mots comme repeat comme nom d'argument. Cela peut paraître anodin, mais étant donné que « repeat » est un mot-clé du langage, jusqu'à présent il fallait soit choisir un autre nom, soit écrire repeat. Et comme il est bien connu que le développeur se doit d'être feignant, ce changement va permettre de gagner du temps.

Voici un exemple de ce qu'il est possible de faire depuis quelques jours :

1. func sayHelloTo(name: String, repeat repeatCount: Int) {

2. for _ in 0 ..< repeatCount {

3. print("Hello  \(name) !")

4. }

5. }

6. sayHelloTo("Taylor", repeat: 5)

IV-B - Disparition du mot-clé var dans les paramètres

Les paramètres annotés avec var deviennent dépréciés. Le mot-clé var était utilisé pour spécifier que le paramètre pouvait être modifié à l'intérieur de la méthode. Mais il était très peu utilisé et était souvent confondu avec le mot-clé inout.

Ci-dessous un exemple d'utilisation du var, valable jusqu'à Swift 2.1 :

1. func sayHelloTo(var name: String) {

2. name = name.uppercaseString

3. print("Hello  \(name) !")

4. }

IV-C - L'utilisation des paramètres externes dans les API Guidelines (Swift 3.0)

Pour revenir sur l'utilisation des paramètres externes, il est intéressant de souligner leur intérêt, car avec l'évolution de Swift par et pour les développeurs, on découvre de nouvelles façons de nommer les méthodes et de tirer parti des paramètres externes.
Par exemple, quand avant une méthode s'écrivait :

1. removeAtIndex(index: Int) -> Element

Elle se retrouve sous cette forme :

1. remove(at index: Int) -> Element

Cet exemple n'en est qu'un parmi tant d'autres, et la page Github regroupant les différences d'API de la standard library est intéressante à parcourir pour voir dans quelle direction se dirige Swift.

IV-D - Le nom du premier paramètre d'une méthode devient obligatoire (Swift 3.0)

Depuis les débuts d'Objective-C, les développeurs souhaitant développer des applications pour Apple devaient changer leurs habitudes d'autres langages pour s'adapter à la syntaxe particulière du nommage de paramètres, le plus gros travail concernant la question du premier paramètre pour adapter le nom de la méthode. Mais cette vérité prendra bientôt fin ! La nouvelle est tombée il y a quelques jours : la proposition d'Erica Sadun de rendre obligatoire le nom du premier paramètre a été acceptée et sera incluse dès la version 3.0 de Swift !
D'ici peu, le nom des paramètres sera donc obligatoirement visible et ce, quel que soit le paramètre ou le cas dans lequel on se place.

Hip hip hip hourra pour Erica Sadun !

V - Conclusion

Nous avons vu, au travers de ce tutoriel, le fonctionnement du nommage des paramètres de fonctions/méthodes dans le cadre d'applications écrites en Objective-C ou Swift, et les évolutions de sa syntaxe. Avec au départ quelques défauts, Apple a su s'adapter aux souhaits des développeurs, pour arriver d'ici quelques mois à un nommage des paramètres, certes toujours un peu verbeux, mais cohérent et beaucoup plus developer-friendly.

VI - Remerciements

Nous tenons à remercier la société Soat qui nous a autorisés à publier ce tutoriel.

Nous remercions également Laethy pour la mise au gabarit et Claude Leloup pour la relecture orthographique.