¿Está bien usar comenzar/terminar en Ruby de la misma manera que usaría #region en C#?

Question

Recientemente me mudé de C# a Ruby, y me falta la capacidad de hacer regiones de código plegables y etiquetadas. Se me acaba de ocurrir que debería estar bien para hacer este tipo de cosas:

class Example 
    begin # a group of methods 

    def method1 
     .. 
    end 

    def method2 
     .. 
    end 

    end 

    def method3 
    .. 
    end 
end 

... pero es que en realidad estaba bien para hacer eso? ¿El método1 y el método2 terminan siendo el mismo tipo de cosa que el método3? ¿O hay alguna expresión de Ruby para hacer esto que no he visto todavía?

Answer 1

Como han dicho otros, esto no cambia la definición del método.

Sin embargo, si desea etiquetar grupos de métodos, ¿por qué no usar la semántica de Ruby para etiquetarlos? Puede usar módulos para dividir su código en fragmentos que pertenecen juntos. Esta es una buena práctica para clases grandes, incluso si no reutiliza los módulos. Cuando el código crezca, será fácil dividir los módulos en archivos separados para una mejor organización.

class Example 
    module ExampleGroup 
    def method1 
     # .. 
    end 

    def method2 
     # .. 
    end 
    end 
    include ExampleGroup 

    def method3 
    # .. 
    end 
end 

Answer 2

Sí, está bien hacer eso (es decir, no cambia la semántica de su código).

Sin embargo, este no es un patrón común y podría ser confuso para los lectores de su código que no entendieran cuál es el propósito del bloque begin ... end.

Answer 3

Creo que debería estar bien. No lo he visto mucho sin embargo. Otra forma en que podría lograr lo mismo, utilizando menos sangrado, es cerrar y volver a abrir la clase, así:

class Example 
    def method1 
    .. 
    end 

    def method2 
    .. 
    end 
end 

# optionally put some other code here 

class Example 
    def method3 
    .. 
    end 
end 

Creo que esto se utiliza a menudo para que usted puede poner otro código en el medio, tales como cuando hay una constante definida en el primer bloque class Example, que se usa para definir una constante en el código del medio, que se usa para definir una constante en el segundo bloque class Example. De esa manera, nunca tendrá que referirse a una constante antes de que esté definida.

Answer 4

Agregando código de Ruby arbitrario para complacer a su editor no me parece del todo razonable. Creo que se debe tratar de conseguir un editor de texto decente, que sería capaz de configurar para utilizar algunas palabras clave que usted pone en sus comentarios que permitan plegado de código existe, por ejemplo:

# region start AAA 

some(:code, :here) 

# region end AAA 

Y si me permito Sé sarcástico: debes saber que Ruby es mucho más expresiva, elegante y bonita que C#, ¡y lo más probable es que no haya ningún código de Ruby oculto en primer lugar! ;)

Answer 5

Sé que esto podría ser un poco viejo, pero me encontré con este problema y encontré una solución arrolladora. Si usas "Rubymine" puedes hacer #regiones.

Esto es donde hablan de las regiones que navegan https://www.jetbrains.com/ruby/help/navigating-to-custom-region.html

#region Description 
Your code goes here... 
#endregion 

Así que con la anterior en el código, verá el siguiente:

editor de código RubyMine - Con un método de muestra usando regiones ONU -preparado

Editor de código Rubymine - Con un método de muestra usando regiones doblado