5種類のRubyコメントとその正しい使い方

Rubyのコメントとは何ですか？

Rubyコメントは、あなたや他の開発者に役立つかもしれない情報をコードに追加します。

最も一般的なタイプのコメントは、1行のコメントです。

構文は次のとおりです ：

# I like apples & oranges

3つのことに注意してください ：

1. コメントはポンド（#）で始まります ）記号
2. コメントの内容とコメントの先頭の間にスペースを入れて、読みやすくしました。
3. コメント内のすべてが、コードのように見えても、コードとして解釈されるわけではありません。これは、一時的にできることを意味します コードをコメントアウトして無効にします。

これらのコメントは、コード行の最後で単独で、またはインラインで使用できます。

このように ：

[].size # get array size

他の種類のコメントはありますか？

はい、魔法のコメント、複数行のコメント、ERBのコメントがあります。

それらを調べてみましょう！

Rubyで複数行コメントを使用する方法

Rubyでは、通常の1行コメントで複数行コメントを行います。

これらを「ブロックコメント」と呼ぶ人もいます。

ここに例があります ：

# aaa
# bbb
# ccc

これが、Rubyのコードブロックをコメントアウトする方法です。

最新のコードエディタを使用すると、コードのブロックを選択してすべてにコメントを付けることができます キーボードショートカットを使用するため、余分な労力は必要ありません。

ただし、特別な複数行コメント構文があります。

このように見えます ：

=begin
This is a comment...
a
b
c
=end

誰もこの構文を使用しません…

醜く、インデントされたもの（メソッドなど）の中で使用することもできませんが、野生で見つけた場合は存在することを知っておくとよいでしょう。

SheBangコメント

シバン（#! ）は、Unixシェル（bashなど）にこのファイルの解釈方法を指示する特別な種類のコメントです。

このコメントをファイルの先頭に追加すると…

Rubyファイルを実行可能ファイルとして実行できるようになります。適切な権限がある場合 それをするために。

シバンのコメントは次のようになります：

#!/usr/bin/env ruby

これにより、警告オプションなどの特定のコマンドラインオプションを設定することもできます。

例 ：

#!/usr/bin/env ruby -w

このコードを実行するたびに、これらのオプションで実行されるため、手動で渡す必要はありません。

マジックコメントの使用方法

魔法のコメントは、Rubyインタープリターの動作を何らかの方法で変更します。

例 ：

frozen_string_literals コメントを付けると、デフォルトで文字列がフリーズします。

このように見えます ：

# frozen_string_literal: true

別の魔法のコメントを使用すると、ファイルのエンコーディングを変更できます。

ここに例があります ：

# encoding: utf-8

これは興味深いものです。warn_indentコメント ：

# warn_indent: true

これにより、インデントが間違っている場合は常に警告が表示されます。

例 ：

def comments
  end

結果 ：

warning: mismatched indentations at 'end' with 'def' at 3

ERBコメント

RailsビューにERBを使用していて、コメントを追加する必要がある場合…

次に、この構文を使用できます ：

<%# ERB comment %>

私はこれの大ファンではありません。なぜなら、コメントを必要としないように、ロジックのほとんどを自分の見解から遠ざける必要があると信じているからです。

デバッグの一部のコードを無効にしようとしています ？

次に、そのコードを削除してgitを信頼するか、使用しているバージョン管理システムを削除します。

概要

通常のコメント（#を含むさまざまな種類のRubyコメントについて学びました ）、シバンコメント（#! ）＆魔法のコメント（# frozen_string_literal: true ）！

この記事が役に立ったと思ったら、友人と共有してください。友人もこれを楽しむことができます。

読んでくれてありがとう！