【Ruby on Rails】ビューを複数行コメントアウトする方法について解説します

Ruby on Rails

2021.08.11

こんにちは。たいら(@tairaengineer2)です。
転職を繰り返し現在4社経験している、11年目エンジニアです。

この記事では、 Ruby on Railsでビューを複数行コメントアウトする方法についてを丁寧に解説していきます。

前提条件：実行環境について
ビューを複数行コメントアウトする方法を解説
1. 方法その1：beginとendで囲む
2. 方法その2：if falseを使う
ビューを複数行コメントアウトする方法を解説するプログラムの概要
実行して確認
まとめ：ビューを複数行コメントアウトしてみよう

前提条件：実行環境について

実行環境は以下の通りです。

OS	Windows10
Rubyのバージョン	2.6.6
Ruby on Railsのバージョン	6.0.3.6

ビューを複数行コメントアウトする方法を解説

ビューを複数行コメントアウトする方法を解説します。

コメントアウトするには

beginとendで囲む
if falseを使う

の2つの方法があるので、それぞれを解説します。

方法その1：beginとendで囲む

beginとendで囲む方法を解説します。

コメントアウトするには

<%
=begin
%>
    コメントアウトしたいもの
<%
=end
%>

=begin

コメントアウトしたいもの

=end

というようにbeginとendで囲むとコメントアウトすることができます。

注意点として、beginとendの=（イコール）は上記のサンプルのように左端に書く必要があります。
なぜならもし

<%
 =begin
%>
    コメントアウトしたいもの
<%
 =end
%>

=begin

コメントアウトしたいもの

=end

のように左端に書かなかった場合

Encountered a syntax error while rendering template

1	Encountered a syntax error while rendering template

とエラーとなってしまうためです。
beginとendの=（イコール）には、お気を付けください。

方法その2：if falseを使う

if falseを使う方法を解説します。

コメントアウトするには

<% if false %>
    コメントアウトしたいもの
<% end %>

<% if false %>

コメントアウトしたいもの

<% end %>

というように囲むとコメントアウトすることができます。

では、次の章で実際に使ってみます。

ビューを複数行コメントアウトする方法を解説するプログラムの概要

ビューを複数行コメントアウトする方法を解説するプログラムは、

コントローラー
ビュー
config\routes.rb

3つを使います。
コントローラーの新規作成時にアクションとビューを作成できるやり方は、以下の記事をご参考ください。

【Ruby on Rails】コントローラーを新規作成するときアクションとビューを同時に作成するやり方を解説します

コントローラーは以下に

controllers\hoge_controller.rb

ビューは以下にそれぞれ格納します

views\hoge\index.html.erb

コントローラーからビューに値を渡します。
渡された値をコメントアウトし、画面で表示を確認します。

コントローラからビューに値を渡す方法については、こちらの記事をご参考ください。

【Ruby on Rails】コントローラからビューに値を渡す方法について解説します

コントローラーのサンプルプログラム

class HogeController < ApplicationController
  def index
    @begin_comment = 'begin-endコメント'
    @if_false = 'if falseコメント'
  end
end

class HogeController < ApplicationController

def index

@begin_comment = 'begin-endコメント'

@if_false = 'if falseコメント'

end

ビューのサンプルプログラム

<h1>beginとendで囲む表示確認</h1>
<p>コメントアウト始まり</p>
<%
=begin
%>
    <p>値表示確認</p>
    <p>
        <%= @begin_comment %>
    </p>
<%
=end
%>
<p>コメントアウト終わり</p>

<h1>if falseを使う表示確認</h1>
<p>コメントアウト始まり</p>
<% if false %>
    <p>値表示確認</p>
    <p>
        <%= @if_false %>
    </p>
<% end %>
<p>コメントアウト終わり</p>

<h1>beginとendで囲む表示確認</h1>

<p>コメントアウト始まり</p>

=begin

<p>値表示確認</p>

<p>

<%= @begin_comment %>

</p>

=end

<p>コメントアウト終わり</p>

<h1>if falseを使う表示確認</h1>

<p>コメントアウト始まり</p>

<% if false %>

<p>値表示確認</p>

<p>

<%= @if_false %>

</p>

<% end %>

<p>コメントアウト終わり</p>

config\routes.rbのサンプルプログラム

Rails.application.routes.draw do
  get 'hoge/index'
end

Rails.application.routes.draw do

get 'hoge/index'

end

実行して確認

コメントアウトできているのかを実行して確認します。
Ruby on Railsでサーバーを立ち上げるコマンドは

rails server

1	rails server

です。
サーバーを立ち上げるコマンドの詳細な説明は、こちらの記事をご参考ください。

【Ruby on Rails】アプリケーションを起動するやり方を解説します

【http://localhost:3000/hoge/index】のURLにアクセスすると、

beginとendで囲む
if falseを使う

どちらの方法でもコメントアウトできていることが確認できました。

デベロッパーツールでHTMLを確認しても、コメントアウトできていることが確認できました。

まとめ：ビューを複数行コメントアウトしてみよう

以上がRuby on Railsでビューを複数行コメントアウトする方法の解説でした！

あなたのご参考になったのなら、とても嬉しいです(*´▽｀*)
ではでは～(・ω・)ﾉｼ