1
0
mirror of https://github.com/jbranchaud/til synced 2026-01-04 23:58:01 +00:00

Add Multi-Line Comments as a Ruby TIL

This commit is contained in:
jbranchaud
2024-08-22 11:12:28 -05:00
parent 4ff1a381d1
commit bd49b31bb0
2 changed files with 48 additions and 1 deletions

View File

@@ -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). 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) - [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) - [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) - [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) - [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) - [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) - [Next And Previous Floats](ruby/next-and-previous-floats.md)

View File

@@ -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)