Wo können private Methoden in Ruby platziert werden?

Die meisten Blogs, Tutorials oder Bücher verfügen über private Methoden am Ende einer Klasse / eines Moduls. Ist das die beste Vorgehensweise?

Ich finde es bequemer, private Methoden nach Bedarf zu haben. Beispielsweise:

public
def my_method
  # do something
  minion_method
end

private
def minion_method
  # do something
end

public
def next_method
end

Auf diese Weise finde ich den Code besser lesbar, anstatt kontinuierlich auf und ab zu scrollen, was sehr irritierend ist.

Stimmt etwas schrecklich an diesem Ansatz nicht? Ist es nicht nur eine bewährte Methode und etwas anderes, private Methoden im Grunde zu haben?

Aus meiner Sicht ist es die beste Vorgehensweise, nacheinander vorzugehen und Ihre Methoden zu deklarieren, ohne die Sichtweise privat zu halten.

Am Ende können Sie jede Methode privat machen, indem Sie einfach Folgendes hinzufügen: private :xmethod

Beispiel:

class Example
 def xmethod
 end

 def ymethod
 end

 def zmethod 
 end

 private :xmethod, :zmethod

end

Rechtfertigt dies Ihre Frage?

Es gibt auch die Möglichkeit, privateder Methodendefinition seit Ruby 2.1 voranzustellen.

class Example

 def xmethod
 end

 private def ymethod
 end

 private def zmethod 
 end

end

Wenn Sie sich die Definition ansehen, wissen Sie sofort, ob eine Methode privat ist, unabhängig davon, wo in der Datei sie definiert ist. Es ist ein bisschen mehr Tippen (wenn Sie nicht automatisch vervollständigen) und nicht alle Ihre defs werden gut ausgerichtet sein.

Wie andere bereits betont haben, besteht die Konvention darin, private Methoden unter eine private Klasse zu stellen. Sie sollten jedoch wahrscheinlich auch wissen, dass viele Programmierer hierfür eine Methode mit doppeltem Einzug (4 Leerzeichen anstelle von 2) verwenden. Der Grund dafür ist, dass Sie in Ihrem Texteditor häufig nicht "privat" sehen und davon ausgehen, dass sie öffentlich sein könnten. Siehe unten für eine Illustration:

class FooBar

  def some_public_method
  end

  def another_public_method
  end

private

    def some_private_method
    end

    def another_private method
    end

end

Diese Methode sollte verhindern, dass Sie nach oben und unten scrollen müssen, und andere Programmierer in Ihrem Code komfortabler machen.

Ich denke, dass öffentliche Methoden eine Art Schnittstelle des Objekts sind, und es ist logisch, sie an der prominentesten Stelle zu platzieren, dh oben in der Datei.

Sie müssen nicht jede Methode publicoder privatedarüber setzen . Normalerweise setze ich alle meine privaten Methoden am Ende meiner Klasse ein. Sie müssen auch nicht explizit angeben public, dass Methoden standardmäßig öffentlich sind. Beispielsweise:

class FooBar

  def some_public_method
  end

  def another_public_method
  end

private

  def some_private_method
  end

  def another_private method
  end

end

Ich komme aus dem Java-Hintergrund und ich hasse es, scrollen zu müssen, um den Methodentyp zu sehen. Ich finde es verrückt, dass man ohne Hässlichkeit keine Sichtbarkeit von Methoden pro Methode festlegen kann. Also habe ich #privatevor jeder Saugmethode einen Kommentar eingefügt und dann erklärt private :....

Ich mag es nicht, für jede Methode öffentlich oder privat angeben zu müssen. Wenn ich alle privaten Methoden nach unten setze, kann ich eine einzelne Instanz von "privat" pro Datei haben. Ich denke, es ist Geschmackssache.

Ein Stil ist zu Gruppenmethoden zusammen , so dass Sie nur verwenden privateund protectedeinmal pro Klasse höchstens. Ein anderer Stil besteht darin, die Sichtbarkeit direkt nach der Methodendefinition anzugeben:

class Example
  def my_private_method
  end
  private :my_private_method

  def my_public_method
  end
end

Ab Ruby 2.1.0 wird defder Methodenname als Symbol zurückgegeben, sodass ein optimierterer Stil möglich ist:

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

(Beachten Sie, dass wir private_class_methodfür Klassenmethoden verwenden - sonst würden wir NameError: undefined methodseitdem bekommenprivate erwartet eine Instanzmethode Selbst wenn es als ein Makro wie im ursprünglichen Beispiel unter Verwendung von nur sie die Sichtbarkeit von Instanzmethoden beeinflusst..)

Ich mag diesen Inline-Sichtbarkeitsstil am besten, da Sie damit Methoden nach Ihren Wünschen organisieren können. Es verringert das Risiko, eine neue Methode am falschen Ort hinzuzufügen und sie versehentlich privat zu machen.

Die Syntax der Klassenmethode kann stattdessen folgendermaßen behandelt werden:

class Example
  private def my_private_method
  end

  class << self
    private def my_private_class_method
    end
  end
end

Dennis hatte die perfekte Antwort, dh wenn Sie ruby> = 2.1 verwenden, stellen Sie dem def einfach private (oder geschützte, öffentliche) voran.

Aber ich glaube, dass es jetzt auch möglich ist, privat als Block zu verwenden, wie in:

private begin
   def foo
   end
   def bar
   end
end

def zip
end

Im Allgemeinen bestelle ich meine Methoden wie folgt:

1. Konstrukteur
2. Andere öffentliche Methoden in alphabetischer Reihenfolge
3. private, nur einmal geschrieben
4. Private Methoden in alphabetischer Reihenfolge

Ich verwende in meinem Editor die Funktionen "Zur Definition gehen", damit nicht viel gescrollt wird. Wenn die Klasse groß genug ist, dass das Scrollen problematisch wird, sollte sie wahrscheinlich in mehrere Klassen unterteilt werden.