rails - Ruby nombrando convenciones?
ruby class comments (3)
El resaltado de sintaxis en su editor de texto puede darle algunas buenas pistas a medida que aprende un idioma y trata de desarrollar un instinto para sus convenciones, aplicado y de otro modo. Yo uso el editor de Linux Gedit.
Ayer me sorprendió gratamente descubrir que algunas de las convenciones para comentar recomendadas por The Ruby Style Guide https://github.com/bbatsov/ruby-style-guide , como # TODO y # FIXME , aparecen como negrita brillante amarillo. Los nombres constantes con TODOS LOS CAPS son negrita cian. Por supuesto, diferentes editores utilizan diferentes esquemas de color.
Por ejemplo, para constantes, es:
THIS_CONSTANT
This_Constant
ThisConstant
O algo mas...?
De hecho, ¿hay algún tipo de (cuasi |) referencia oficial para todo este tema?
También me gustaría poder revisar rápidamente preguntas como:
¿Qué patrones de nomenclatura son aplicados por Ruby mismo (p. Ej.,
Constants debe comenzar con un capital, ¿verdad?) Y que son simplemente convenciones (method_names debe estar en snake case, ¿verdad?)?¿Hay alguna convención sobre cómo escribir un recordatorio de qué clase se supone que una variable debe tener en su nombre? ("Notación húngara" o lo que sea ... Es decir, tengo la impresión de que si alguna vez siente la necesidad de usarlo en el código Ruby, lo está haciendo mal, pero independientemente de ello, ¿ hay alguna convención?)
y así...
En breve
El caso de camello para la definición de clases y módulos usamos CamelCase
El caso de serpiente para archivos, variables y métodos: snake_case
La Guía de estilo de Ruby es un esfuerzo público para recomendar convenciones y mejores prácticas coherentes para los desarrolladores de Ruby. Usted deberia comprobar esto.