◆当サイトで人気のプログラミング教室のおすすめランキングはこちら!
プログラミングは独学では非効率で、時間を無駄にするリスクがあります。効率的なカリキュラムで学べるスクールを受講しましょう。

DMM WEBCAMP【マンツーマンサポート】1ヶ月短期集中でプログラミングを学ぶスクール
1ヶ月通い放題・メンター常駐の教室環境でプログラミングを学びたい方!
TechAcademyオンラインで開講しているプログラミングスクール
オンラインでどこでも学べる!/教室に行くのが忙しい人でも安心!
TECH::CAMP教養としてのITスキルを学べるスクール
Webデザイン/AI(人工知能)/IOS/Androidアプリ制作/VRを学びたい方!
DMM WEBCAMP PRO転職保証付き!エンジニアとして転職したい人におすすめ!
未経験からプロのエンジニアへ3ヶ月で転職する為のスクールです!
1月生募集中!当社人気の転職保証コース
プログラミング学習から転職成功まで導く、当社人気のDMM WEBCAMP PROコース。
12月生は満員となっております。1月生募集に向け、お早めの申込みをオススメします。
プログラミング未経験でもエンジニア転職を絶対成功させたい
スキルを身に着けて人生を自ら切り開きたい
上記にあてはまる方は、ぜひご検討ください!

コメントは、プログラムそのものには、まったく影響しません。
あってもなくても影響しないのであれば、必要ないと考える人もいるかもしれません。

しかし、コメントは、それだけで多くの議論を巻き起こすほど重要なものでもあります。

何を書くの?

そもそも、コメントには何を書くべきかの前に、なぜ必要なのかを説明しましょう。

コメントは、前述の通り、「プログラムの動き」にはなにも影響しないものです。

しかし、「プログラムの理解」には非常に大きな影響を与えます。

つまり、プログラムを人が理解するために、書く必要があるのです。

最近のプログラムは、ほとんどの場合、複数の人が一緒に作ります。そのため、他の人が作ったプログラムを元にあったものを作らないといけませんし、ときには他の人が作ったプログラムを修正しなければいけません。

そんなときに、コメントは、とても役に立つのです。

それに加えて、プログラマーの間では、「今日書いたプログラムを、来週の自分は理解できない」という言葉があります。

つまり、コメントがなければ、自分が作ったプログラムすら、すぐには分からなくなってしまうのです。

そのため、書く内容はただひとつ、「プログラムの理解に役立つ情報」なのです。

書き方の決まり

コメントは、前述の通りプログラムに影響がありません。

しかし、だからこそ、きちんと一定のルールを決めておかなければ、よく分からないものになってしまうでしょう。

その一定のルールというのは、ただひとつ、「分かりやすく書く」ということです。

そもそものコメントは「プログラムの理解に役立つ情報」を記載するものですので、当然かもしれません。

適切な位置に適切な量のコメントを入れるわけです。

そして、書く内容は、「その場所のコードを見ただけでは分からないこと」にすることが重要です。

といっても、最初はよく分からないと思います。

そこで、簡単な練習方法を紹介しましょう。

それは、最初のうちは「好きなだけ」コメントを入れることです。

それに加えて、まったくコメントを入れていないものも、コピーして残しておきます。

もちろん、コメントの入力は面倒なところもありますが、そうすることによって、プログラムの理解度を確認することもできますので、一石二鳥です。

そして、翌週、コメントを入れていないプログラムを見直し、理解できないところを見つけましょう。コメントを入れたファイルを確認して、理解できないところに入れてあるコメントを見つけます。そのコメントが、必要なコメントということです。

これを繰り返せば、どういったコメントを入れれば良いのかを身に付けつつ、Rubyの理解も深まることでしょう。

コメントの書き方

では、具体的なコメントの書き方を説明していきます。

いままで見たことのないコメントもあるかもしれませんが、理解しておきましょう。

“未経験”でもたった1ヶ月で営業からエンジニアとして転職!『WebCamp』受講者インタビュー

1行コメント

とても使う機会の多いコメントが1行コメントです。

サンプルプログラムなどで見たことのある人は多いでしょう。

記載方法は、以下の例のように「#」を入力します。

# ○○処理の開始 …①
a = 1

a = 1 # ○○用に、1にしておく …②

一般的に、ある処理の固まりが始まるときは、①のようにコメントを入れます

その1行の処理の説明だけしたい場合は、②のような書き方をします。

なお、②を見れば分かる通り、「1行コメント」といっても、「#」を入力した行すべてがコメントになる(コメントアウトされると言います)わけではありません。

コメントアウトされるのは、#からその行の最後(改行)までです。

もちろん、①のように行の先頭に#を入力すれば、その行はすべてコメントアウトされますので、1行コメントにふさわしい状態になります。

複数行コメント

あるまとまった複数行をコメント扱いにできるのが、この方法です。記載方法は以下のようになります。

a = 10

=begin
この部分はコメントです。
a = 1
としても実行されません。
# コメント内のコメントは、コメントです。
=end

puts(a)

複数行のコメントを必要とするようなシーンは、あまり思い付かないかもしれません。事実、プログラムの説明で長文を書くようなことを行いません。(日本語で説明を書くよりも、プログラムを見るほうが明らかに分かりやすいです)

しかし、複数行コメントでなければ面倒な、重要なシーンがひとつあるのです。

それが、「プログラムをコメントアウトする」ことです。

具体的には、次のような場合が当てはまります。

すでに動いているある処理について、別の方法に気がついたとしましょう。新しい方法のほうが優れているとしても、すでに動くことが分かっている処理を削除して新しい方法のプログラムを書くのは、危険です。

そのため、古いプログラムを消さずに=beginと=endで囲んでコメントアウトし、新しいプログラムを作って動作確認をするわけです。

こうしておけば、いざというときに古いプログラムをすぐに復活させることができます。

同じことを「#」で行えば、結構な手間になると思います。

時間や場所にとらわれず自由に働くために必要なスキルとは?【WebCamp卒業生インタビュー】

コメントのデメリット

ここまで、コメントの重要性や意味を説明してきました。

コメントは、プログラムを理解するためになくてはならないものです。むしろ、1人で作る場合でも、プログラムを改善したり、使い回したりするために、大きな助けとなるものです。

しかし、なんでもそうですが、メリットもあればデメリットもあります。

ここからは、コメントのもつマイナス面を紹介します。

多すぎると

すでに上で紹介した練習方法で経験した人もいるかもしれませんが、コメントを思い付く限り入れていくと、いくらでも入れることができます。

そして、そのプログラムを見直してみたときに、コメントが多すぎて肝心な部分が埋もれて分からないことがあります。

そのため、コメントは最低限にすべきだと意識すべきでしょう。そう考えると、上述したように「プログラムを見れば分かること」は書かなくなります。

また、プログラムの各行すべてにコメントすることもなくなります。最終的には、処理の固まりごとのコメントばかりになることが多いですが、その程度で十分です。

コツコツ独学×スクールで実践。未経験からエンジニアに転職!【WebCamp卒業生インタビュー】

間違っていると

いくらコメントが適切に入っていても、そのコメントが間違っていると何の意味もおりません。

コメントは、「プログラムの理解に役立つ情報」でなければいけないのに、コメントを信じたばかりに間違って理解してしまうのは本末転倒でしょう。

もちろん、コメントがプログラムのコードと詳細までイコールである必要はありません。そのプログラムで「何がしたいのか」、「何のためにこのようなプログラムになっているのか」を正しく伝えてあれば、良いのです。

プログラムを読むときにコメントを見る人は、コメントでプログラムの流れを追うのではありません。「コメントを念頭に置いて、プログラムを読む」のです。そのため、実際のプログラムと違う意図のコメントがあると、混乱が起きることは想像できるでしょう。

間違ったコメントを信じたばかりに、重大な不具合を起こしてしまうことも少なくありません。

なお、コメントの間違いが起きるのは、ほとんどの場合「プログラムを修正したとき」です。

プログラムを修正することによって、その意図にずれが発生しているのに、コメントの修正を忘れてしまうことは、非常に多いミスの原因です。

プログラムを修正したら、必ずコメントも修正するようしなければいけません。

まとめ

コメントについて、説明しました。

コメントはプログラムの動きそのものには関係ないからこそ、自分でルールを守る自己管理が重要です。

そのため、説明が少し説教くさくなったかもしれませんが、ご了承ください。

なにより、誰かにプログラムを見せるとき、コメント違いは非常に恥ずかしいものですので、気をつけましょう。

・コメントはプログラムの動きに影響しない
・コメントは、プログラムの理解に役立つ情報
・コメントは、その場所のコードを見ただけでは分からないことを書く
・コメントが多すぎるとプログラムが読みにくい
・コメントが間違っていることで、不具合を起こすこともある
・プログラムを修正したら、コメントも必ず修正すること

 

DMM WEWBCAMP/DMM WEBCAMP PROについて

DMM WEBCAMPは1ヶ月でプログラミング・WEBデザインを学ぶ通い放題のプログラミングスクールです。DMM WEBCAMP PROは3ヶ月間で未経験から即戦力エンジニアを育成する転職保障付きのプログラミングスクールです。

2つのサービスを運営するインフラトップでは、「学びと仕事を通して人生を最高の物語にする」という理念で会社を経営しています。

キャリアアップを目指す方は、この機会に私達と一緒にプログラミングを学んでみませんか?

1月枠も残りわずか当社人気の転職保証コース
プログラミング学習から転職成功まで導く、当社人気のDMM WEBCAMP PROコース。
12月受入枠は満員となっております。1月枠に向け、お早めの申込みをオススメします。
プログラミング未経験でもエンジニア転職を絶対成功させたい
スキルを身に着けて人生を自ら切り開きたい
上記にあてはまる方は、ぜひご検討ください!

▼未経験から1ヶ月でWEBデザイン・プログラミングを学びたい方はこちら!


▼ついに開講!オンラインでWEBデザイン・プログラミングを学びたい方はこちら!

 

【インタビュー】1ヶ月でRubyをゼロから学び、Webエンジニアとして転職!

ブラジルから帰国し技術をつけようとRubyエンジニアを目指してWebCampでRubyを学び、見事Webエンジニアとして転職を果たした田中さんにお話を伺いました。

Rubyの学習がしたい。基礎をしっかりと理解したい

転職のサポートがほしい

と考えている方はぜひお読み下さい。

【WebCamp卒業生インタビュー】1ヶ月でRubyをゼロから学び、Webエンジニアとして転職!

おすすめの記事