Datasets:
gadams
/
ruby

Dataset card Data Studio Files
xet
Community
text
stringlengths
0
444
some_var = 5
def some_method
# some code
end
----
=== Identifiers with a Numeric Suffix [[snake-case-symbols-methods-vars-with-numbers]]
Do not separate numbers from letters on symbols, methods and variables.
[source,ruby]
----
# bad
:some_sym_1
some_var_1 = 1
var_10 = 10
def some_method_1
# some code
end
# good
:some_sym1
some_var1 = 1
var10 = 10
def some_method1
# some code
end
----
=== CapitalCase for Classes and Modules [[camelcase-classes]]
NOTE: `CapitalCase` is also known as `UpperCamelCase`, `CapitalWords`
and `PascalCase`.
Use `CapitalCase` for classes and modules.
(Keep acronyms like HTTP, RFC, XML uppercase).
[source,ruby]
----
# bad
class Someclass
# some code
end
class Some_Class
# some code
end
class SomeXml
# some code
end
class XmlSomething
# some code
end
# good
class SomeClass
# some code
end
class SomeXML
# some code
end
class XMLSomething
# some code
end
----
=== Snake Case for Files [[snake-case-files]]
Use `snake_case` for naming files, e.g. `hello_world.rb`.
=== Snake Case for Directories [[snake-case-dirs]]
Use `snake_case` for naming directories, e.g. `lib/hello_world/hello_world.rb`.
=== One Class per File [[one-class-per-file]]
Aim to have just a single class/module per source file.
Name the file name as the class/module, but replacing `CapitalCase` with `snake_case`.
=== Screaming Snake Case for Constants [[screaming-snake-case]]
Use `SCREAMING_SNAKE_CASE` for other constants (those that don't refer to classes and modules).
[source,ruby]
----
# bad
SomeConst = 5