擬似言語のコメントの書き方

プログラムの中には、実行されない説明を書くことがあります。 これをコメントと呼びます。

コメントは、主にプログラムを分かりやすく説明するために記述します。 擬似言語を読むときも、コメントがあると「この行は何をしているのか」が理解しやすくなります。

基本情報技術者試験のような問題でも、処理の意味をつかむうえでコメントがヒントになることがあります。

コメントの書き方

擬似言語では、以下のようにコメントを記述します。

// コメント文章

もしくは、

/* コメント文章 */

擬似言語では、// から後ろをコメントとして書けます。 例えば、

sum ← sum + score[i]  // i番目の点数を合計に加える

のように記述します。 その行の処理を短く説明したいときに便利です。

また、/* コメント文章 */のようにコメントを書く形です。

/* 
合計を人数で割って平均を求める
合計を入れる変数を0で初期化する
 */

上記のように、1行でも複数行でも説明を書きたいときに使いやすいです。

コメントがプログラムに影響されないことを確認しよう

以下のプログラムをシミュレーターで実行してみましょう。

○main
整数型: price
整数型: count
整数型: total
price ← 100 // 1個の値段
count ← 4 // 個数

/* 合計を計算 */
total ← price × count
print(total)

実行すると 400 と表示されます。 コメントは説明なので、計算には使われません。

price ← 100 や count ← 4 のような処理は実行されますが、// 1個の値段 や /* 合計を計算 */ の部分は実行されません。 つまり、コメントはプログラムの動きを変えずに、読む人の理解を助けるためのものです。

なぜコメントを書くのか

短いコードなら、コメントがなくても読めるかもしれません。 でも、少し長くなると、何をしているのか迷うことがあります。

コメントは次のような場面で役立ちます。

• 変数の役割を説明したいとき
• 条件式の意味を補足したいとき
• 計算の目的を残したいとき
• あとで見直すポイントを残したいとき

ただし、何でもコメントにすればよいわけではありません。 見れば分かることを何度も書くと、逆に読みづらくなります。

コメントは読みやすくするために使う

コメントを書く目的は、コードを長くすることではありません。 あとから読んだときに、処理の意味を思い出しやすくすることです。

擬似言語の学習では、最初のうちはコメントを見ながら処理の意味を確認すると読みやすくなります。 慣れてきたら、自分でも短いコメントを書いて、コードの意味を整理してみましょう。

書きすぎず、でも大事なところには残す。

このバランスを少しずつ身につけましょう。