Де розмістити приватні методи в Ruby?

Більшість блогів, навчальних посібників чи книг мають приватні методи внизу будь-якого класу / модуля. Це найкраща практика?

Я вважаю, що використання приватних методів, як і коли потрібно, є більш зручним. Наприклад:

public
def my_method
  # do something
  minion_method
end

private
def minion_method
  # do something
end

public
def next_method
end

Таким чином, я вважаю код більш читабельним, замість того, щоб постійно прокручувати вгору і вниз, що дуже дратує.

Чи є щось страшенно неправильне у цьому підході? Мати приватні методи внизу - це не просто найкраща практика та щось інше?

Найкраща практика на мою точку зору - послідовно йти і заявляти про свої методи, не дотримуючись приватної точки зору.

Зрештою, ви можете зробити будь-який метод приватним, просто додавши: private :xmethod

Приклад:

class Example
 def xmethod
 end

 def ymethod
 end

 def zmethod 
 end

 private :xmethod, :zmethod

end

Чи виправдовує це ваше запитання?

Також існує можливість додавання privateдо визначення методу, починаючи з Ruby 2.1.

class Example

 def xmethod
 end

 private def ymethod
 end

 private def zmethod 
 end

end

Переглядаючи визначення, ви миттєво знаєте, чи є метод приватним, незалежно від того, де у файлі він визначений. Це трохи більше набору тексту (якщо ви не виконуєте автозаповнення), і не всі ваші defs будуть добре вирівняні.

Як вже вказували інші, конвенція полягає в тому, щоб помістити приватні методи внизу, під один приватний клас. Однак, мабуть, вам також слід знати, що багато програмістів використовують для цього метод подвійного відступу (4 пробіли замість 2). Причина полягає в тому, що часто в текстовому редакторі ви не побачите "приватний" і припускаєте, що вони можуть бути загальнодоступними. Див. Ілюстрацію нижче:

class FooBar

  def some_public_method
  end

  def another_public_method
  end

private

    def some_private_method
    end

    def another_private method
    end

end

Цей метод повинен уникнути необхідності прокручувати вгору і вниз і зробить інших програмістів зручнішими у вашому коді.

Я думаю, що загальнодоступні методи - це якийсь інтерфейс об’єкта, і логічно розміщувати їх на найвидатнішому місці, тобто у верхній частині файлу.

Вам не потрібно ставити publicабо privateнад кожним методом. Я зазвичай ставлю всі свої приватні методи внизу свого класу. Крім того, не потрібно чітко говорити, publicоскільки методи є загальнодоступними за замовчуванням. Наприклад:

class FooBar

  def some_public_method
  end

  def another_public_method
  end

private

  def some_private_method
  end

  def another_private method
  end

end

Я походжу з фону Java, і я ненавиджу прокручувати, щоб побачити тип методу. Я думаю, це божевільно, що не можна визначити видимість методу для кожного методу без потворності. Тож я закінчив додавати коментарі #privateперед кожним методом смоктання, а потім оголошувати private :....

Мені не подобається вказувати відкритий або приватний для кожного методу. Розміщення всіх приватних методів внизу дозволяє мені мати один екземпляр "приватного" на файл. Думаю, це справа смаку.

Один стиль для групових методів разом , так що ви використовуєте тільки privateі protectedодин раз в класі максимум. Інший стиль - це вказати видимість відразу після визначення методу:

class Example
  def my_private_method
  end
  private :my_private_method

  def my_public_method
  end
end

Починаючи з Ruby 2.1.0, defповертає назву методу як символ, тому можливий більш впорядкований стиль:

class Example
  private def my_private_method
  end

  def my_public_method
  end

  protected def my_protected_method
  end

  private_class_method def self.my_private_class_method
  end
end

(Зверніть увагу, що ми використовуємо private_class_methodдля методів класу - інакше ми отримаємо, NameError: undefined methodоскільки privateочікуємо методу екземпляра. Навіть використовуючи його як макрос, як у вихідному прикладі, це впливає лише на видимість методів екземпляра.)

Мені найбільше подобається цей стиль вбудованої видимості, оскільки він дозволяє впорядковувати методи за вашим бажанням. Це зменшує ризик додавання нового методу в неправильному місці та ненавмисне перетворення його на приватний.

Що стосується синтаксису методу класу, замість цього ви можете впоратися з ним таким чином:

class Example
  private def my_private_method
  end

  class << self
    private def my_private_class_method
    end
  end
end

Денніс мав ідеальну відповідь, тобто, коли використовується ruby> = 2.1, просто додайте префікс def до приватного (або захищеного, загальнодоступного)

Але я вважаю, що тепер також можна використовувати private як блок, як у:

private begin
   def foo
   end
   def bar
   end
end

def zip
end

Як правило, я замовляю свої методи наступним чином:

1. Конструктор
2. Інші публічні методи в алфавітному порядку
3. private, написаний лише один раз
4. Приватні методи, в алфавітному порядку

Я використовую функції "перейти до визначення" у своєму редакторі, щоб це не вимагало великої прокрутки, і в будь-якому випадку, якщо клас досить великий, що прокрутка стає проблематичною, її, мабуть, слід розбити на кілька класів.