diff --git a/README.md b/README.md index 09e8e34..a18b949 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ pairing with smart people at Hashrocket. For a steady stream of TILs, [sign up for my newsletter](https://crafty-builder-6996.ck.page/e169c61186). -_1436 TILs and counting..._ +_1437 TILs and counting..._ --- @@ -1180,6 +1180,7 @@ _1436 TILs and counting..._ - [Map With Index Over An Array](ruby/map-with-index-over-an-array.md) - [Mock Method Chain Calls With RSpec](ruby/mock-method-chain-calls-with-rspec.md) - [Mocking Requests With Partial URIs Using Regex](ruby/mocking-requests-with-partial-uris-using-regex.md) +- [Multi-Line Comments](ruby/multi-line-comments.md) - [Named Regex Captures Are Assigned To Variables](ruby/named-regex-captures-are-assigned-to-variables.md) - [Navigate Back In The Browser With Capybara](ruby/navigate-back-in-the-browser-with-capybara.md) - [Next And Previous Floats](ruby/next-and-previous-floats.md) diff --git a/ruby/multi-line-comments.md b/ruby/multi-line-comments.md new file mode 100644 index 0000000..a72d4a0 --- /dev/null +++ b/ruby/multi-line-comments.md @@ -0,0 +1,46 @@ +# Multi-Line Comments + +Ruby has an obscure syntax for creating multi-line comments. + +In many languages, there is a multi-line comment syntax that looks something +like this: + +```javascript +/* + * multi-line comment in javascript + */ +``` + +This gets used often in those languages. + +In Ruby, the multi-line comment syntax is not something we see very often. It +is a departure from the single-line comment syntax and it also requires no +indentation. + +```ruby +RSpec.configure do |config| + config.order = :random + +# The settings below are suggested to provide a good initial experience +# with RSpec, but feel free to customize to your heart's content. +=begin + # These two settings work together to allow you to limit a spec run + # to individual examples or groups you care about by tagging them with + # `:focus` metadata. When nothing is tagged with `:focus`, all examples + # get run. + config.filter_run :focus + config.run_all_when_everything_filtered = true + + # ... + +=end +end +``` + +Using the `=begin` and `=end` syntax (no indentation), we make everything +inbetween into a comment. + +Though we don't see this too often, I did pull this example directly from the +`spec_helper.rb` file that RSpec generates. + +[source](https://docs.ruby-lang.org/en/master/syntax/comments_rdoc.html)