プログラムを読みやすく書こう
![tutorial-readable.png](/images/docs/tutorial/tutorial-readable.png)
想定時間:10分
今回の内容
- プログラムを読みやすくすると見直しがしやすくなる
- 「コメント」や「インデント」「空行」で読みやすく工夫をする
プログラムを読みやすくする
プログラミングに慣れて複雑なものを作り始めると、エディターに書くプログラムは長くなっていきます。
エラーが起きたり、意図した動きにならなかったりしたとき、たくさんの行を読み返すのは大変です。
長いプログラムを読みやすくする工夫には、「コメント(メモ書き)」や「インデント(字下げ)」「空行」を挿入するというテクニックがあります。
プログラムは一度書いたら終わりということはほとんどありません。実行と検証を繰り返すので、何度も読み返すことになります。あとからでも理解しやすいように、自分の好みに合ったテクニックを取り入れてください。
コメント
rem 命令 や 「//」「'(アポストロフィ)」を行の先頭に使うことで、エディター内にコメントを残すことができます。ここでいうコメントとは、自分用のメモ書きのことです。
どれを使っても同じ効果があります。使いやすいものを使ってください。
rem 命令や「//」「'」が先頭についた行は、コンピューターが読み飛ばして実行してくれるため、何を書いてもエラーが起きることはありません。もちろん、全角を使うこともできます。
🗒️覚えよう
rem 命令や「//」「'」を使うと、エラーを起こさずにエディター内にコメント(メモ書き)ができる
インデント(字下げ)
60~62行目を見てください。行の先頭に空白(スペース)が入っています。
これは、インデント(字下げ)と呼ばれます。プログラムの構造を表現するために使われることが多いです。
「構造」とは何かを説明すると長くなります。ここでは、作文の書き始めを1マス下げて文章を理解しやすくするのと同じような工夫だと知っておいてください。
インデント(字下げ)に使うスペースの数は自由です。スペース2つや4つを使う人が多いといわれています。
スペースはスペースキーを使って入力します。
スペースを入れる代わりにtabキーを使うことでも、インデント(字下げ)をおこなうことができます。
インデント(字下げ)の実例は別のチュートリアルで学習するので、よく覚えておいてください。
🗒️覚えよう
「インデント(字下げ)」は行の先頭にスペースを入れること
スペースキーやtabキーを使う
空行
空行とは、何も書かれていない行のことです。上の画像では、57行目と64行目が空行です。
何も入っていない行でプログラムを挟むと、長いプログラムの中でも、パッと見で「ひとつのまとまり」として認識できるようになります。
たとえば上の画像では「ゲームクリアを表示するときのプログラムのまとまり」が見えるように空行が挿入されています。こうしておくと「ゲームクリアの表示がおかしいな?」と思ったときに、修正部分を見つけやすくなります。
空行は、コメント(メモ書き)と同じようにコンピューターが読み飛ばしてくれます。エラーの原因にはなりません。
空行は、改行するときと同じ Enterキー を使います。
🗒️覚えよう
「空行」は改行して空の行を作ること
Enterキーを使う
プログラムの一定のまとまりを分かりやすくすることが多い
その他「読みやすさ」について
そのほかにも、コンピューターが誤解してしまわない範囲で、自分が読みやすいと感じる工夫を取り入れることもできます。
たとえば、このチュートリアルでは演算子やイコール記号の前後に半角スペースをひとつ入れるようにしています。
これらは、テキストプログラミングを始めたばかりの人でも読みやすくなるよう、余分に追加しているものです。入れないといけないものではありません。スペースを入れなくても正しく動作します。
自分で書くときには、好みで調節してください。
ただし、「print mikka」のように、命令や関数の後のスペースは省略できません。
ひとつの独立した要素(命令や関数・数値・名前など)のあとには、コンピューターが要素の区切りを判断できるようにスペースが最低ひとつ必要です。
❌
好みで不要なところにスペースの追加はできても、必要なところのスペースをなくすことはできません。
今回のおさらい
- rem 命令や「//」「'」を使うと、エラーを起こさずにエディター内にコメント(メモ書き)ができる。
- 「インデント(字下げ)」は、スペースキーやtabキーを使って、行の先頭にスペースを入れること。
- 「空行」は、Enterキーを使って、改行して空の行を作ること。プログラムの一定のまとまりを分かりやすくすることが多い。