5種類のRubyコメントとその正しく使用する方法

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

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

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

構文は次のとおりです:

# I like apples & oranges

三つのことに注意してください:

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

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

.size # get array size

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

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

それらを探検してみましょう!

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

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

一部の人々はこれらを”ブロックコメント”と呼んでいます。

ここに例があります:

# aaa# bbb# ccc

それはまさにrubyのコードブロックをコメントアウトする方法です。

現代のコードエディタでは、キーボードショートカットを使用してコードのブロックを選択することができます&それのすべてをコメントするので、余分な

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

このようになります:

=beginThis is a comment...abc=end

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

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

SheBang Comments

shebang(#!)は、Unixシェル(bashなど)にこのファイルの解釈方法を伝える特別な種類のコメントです。

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

Rubyファイルを実行可能ファイルとして実行することができます。

ここでは、shebangコメントがどのように見えるかです:

#!/usr/bin/env ruby

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

:

#!/usr/bin/env ruby -w

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

マジックコメントの使い方

マジックコメントはRubyインタプリタの動作を何らかの形で変更します。

例:

frozen_string_literalsコメントは、デフォルトで文字列を凍結させます。

このようになります:

# frozen_string_literal: true

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

ここに例があります:

# encoding: utf-8

aここでは興味深いものです、warn_indentコメント:

# warn_indent: true

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

:

def comments end

その結果、:

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

ERB Comments

RAILS views&にERBを使用している場合は、コメントを追加する必要があります…

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


私はあなたがコメントを必要としないように、あなたのロジックのほとんどをあなたの意見から守るべきだと信じているので、私はこれの大ファンではありません。

デバッグのためにいくつかのコードを無効にするために探していますか?次に、そのコード&trust git、または使用しているバージョン管理システムを削除します。



+