Какое имя метода лучше всего подходит для соглашений Objective-C / Cocoa?

Question

Вот быстрый вопрос. Какое название метода имеет наибольшее значение для приложения Objective-C Cocoa?

-(void) doSomethingWithAnimation:(BOOL)animated

или

-(void) doSomething:(BOOL)animated

или даже:

-(void) doSomethingAnimated:(BOOL)animated

Answer 1

Я думаю, что соглашение Какао даст вашим примерам следующую семантику (очевидно, игнорируя тип BOOL для аргумента):

-(void) doSomethingWithAnimation:(BOOL)animated

фактически ожидал бы анимацию в качестве параметра (то есть что-то, что представляет анимацию.

-(void) doSomething:(BOOL)animated

ожидал бы, что Нечто сделает.

-(void) doSomethingAnimated:(BOOL)animated

, как ответил Ной, сделал бы что-нибудь с дополнительной анимацией.

Answer 2

- (void) doSomethingAnimated: (BOOL) анимация кажется наиболее соответствующей стилю именования Apple. Для справки посмотрите документацию по iPhone UIKit - например, -popToRootViewControllerAnimated: метод UINavigationController.

Answer 3

напишите свой комментарий ясно и кратко, например: // сделать что-то с анимацией

Затем напишите название вашего метода на основе этого комментария, как показано ниже doSomethingwithAnimation: (BOOL) анимированный

Objective-C и Cocoa предназначены для хорошего чтения, поэтому, если ваш метод не может быть четким описанием вашего кода, он может иметь неправильное имя.

Answer 4

Вот еще один вариант: создайте два метода, -doSomething и -doSomethingWithAnimation.

Затем, если вы хотите, вы можете сделать так, чтобы они оба вызвали хвостом третий, приватный метод, и дали этому методу любое имя, какое захотите. :)