Quel nom de méthode correspond le mieux aux conventions Objective-C / Cocoa?

Question

Voici une question rapide. Quel nom de méthode a le plus de sens pour une application Objective-C Cocoa?

-(void) doSomethingWithAnimation:(BOOL)animated

ou:

-(void) doSomething:(BOOL)animated

ou même:

-(void) doSomethingAnimated:(BOOL)animated

Answer 1

Je pense que la convention Cocoa donnerait à vos exemples la sémantique suivante (en ignorant évidemment le type BOOL):

-(void) doSomethingWithAnimation:(BOOL)animated

s’attend en fait à ce que l’animation soit un paramètre (c’est-à-dire quelque chose qui représente l’animation.

-(void) doSomething:(BOOL)animated

s’attendrait à quelque chose à faire.

-(void) doSomethingAnimated:(BOOL)animated

, comme Noah répondait, ferait quelque chose avec une animation facultative.

Answer 2

- (void) do Quelque chose d'animé: (BOOL) animé semble plus compatible avec le style de nommage d'Apple. Pour référence, consultez la méthode iPhone UIKit docs - la méthode -popToRootViewControllerAnimated: de UINavigationController:

.

Answer 3

Voici une autre option à considérer: créer deux méthodes, -doSomething et -doSomethingWithAnimation .

Ensuite, si vous le souhaitez, vous pouvez les inviter à appeler une troisième méthode privée et à lui attribuer le nom de votre choix. :)

Answer 4

écrivez votre commentaire clairement et concis, par exemple: // faire quelque chose avec l'animation

Ensuite, écrivez le nom de votre méthode en fonction de ce commentaire, comme ci-dessous quelque chose avec Animation: (BOOL) animé

Objective-C et Cocoa sont conçus pour une bonne lecture. Par conséquent, si votre méthode ne peut pas fournir une description claire de votre code, elle risque de ne pas être bien nommée.