[BASICのはじめ方] Part4: コメントとコードの書き方

目次

はじめに

プログラミングの世界へようこそ！ BASICの学習を進める中で、今回はプログラムの中にメモを残す「コメント」と、読みやすいコードを書くための「書き方（コーディングスタイル）」について学びます。

これらはプログラムの動作に直接影響するものではありませんが、後でコードを見返したときや、他の人と一緒に開発するときに、とても重要になります。しっかり身につけていきましょう！

コメントの書き方

コメントとは、プログラムの中に書くことができる「メモ書き」のことです。プログラムの実行時には無視されるので、自由に説明などを書き込むことができます。

コメントを使う主な目的は次のとおりです：

  • コードの特定の箇所が何をしているのかを説明する。
  • 後で修正するべき箇所（TODO）や、問題がある箇所（FIXME）をメモしておく。
  • 一時的にコードの一部を実行しないようにする（コメントアウト）。

BASICでは、主に2つの方法でコメントを記述します。

1. REM ステートメント
REM (Remarkの略) は、昔からあるコメントの書き方です。REM から行の終わりまでがコメントとして扱われます。 
REM これはコメントです。プログラムの説明をここに書きます。
PRINT "Hello, World!" REM PRINT命令でメッセージを表示します。
2. アポストロフィ (‘)
' (アポストロフィ) を使う方法は、特にQBasicやFreeBASICなどの新しいBASICでよく使われます。アポストロフィから行の終わりまでがコメントになります。REM よりも短く書けるのが特徴です。 
' これもコメントです。アポストロフィを使っています。
LET message$ = "こんにちは" ' 変数に文字列を代入
PRINT message$ ' 変数の内容を表示

ポイント：

  • 行の途中にコメントを入れることもできます。その場合、実行されるコードの後にコメントを書きます。古いBASICでは、コードとREMコメントの間にセミコロン(;)が必要な場合がありましたが、アポストロフィの場合は通常不要です。
  • コメントは、コードを見ただけでは分かりにくい処理の意図や目的を説明するために使いましょう。
  • コメントを書きすぎると、逆にコードが読みにくくなることもあります。シンプルで分かりやすいコメントを心がけましょう。

FreeBASICでは、複数行にわたるコメントを /' で始めて '/ で終わる形式で書くこともできます。 

/' これは複数行コメントです。 プログラムの概要などを書くのに便利です。
'/
PRINT "FreeBASIC Example"

コードの書き方（コーディングスタイル）

コーディングスタイルとは、コードをどのように書くかという「見た目」のルールのことです。一貫したスタイルで書かれたコードは、読みやすく、間違いを見つけやすく、修正もしやすくなります。

特に決まったルールが強制されるわけではありませんが、一般的に推奨される書き方をいくつか紹介します。

インデント（字下げ）

IF...THEN や FOR...NEXT などのブロック構造の中のコードは、行頭にスペースを入れて一段下げる（インデントする）と、コードの構造が分かりやすくなります。スペースの数は、通常2つか4つが使われます。 

' インデントなし（読みにくい例）
FOR i = 1 TO 5
PRINT i
IF i = 3 THEN
PRINT "Three!"
END IF
NEXT i
' インデントあり（読みやすい例）
FOR i = 1 TO 5 PRINT i IF i = 3 THEN PRINT "Three!" ' IFブロックの中はさらにインデント END IF
NEXT i

古い行番号BASICではインデントが難しい場合もありますが、QBasicやFreeBASICのようなモダンな環境では積極的にインデントを活用しましょう。

スペースの挿入

演算子（=, +, - など）やカンマ（,）の後にはスペースを入れると、コードがすっきりと読みやすくなります。 

' スペースなし
LET a=10
LET b=a+5
PRINT a,b
' スペースあり
LET a = 10
LET b = a + 5
PRINT a, b

変数名

変数名はその役割が分かるような、意味のある名前にしましょう（例: `score`, `userName$`）。ただし、古いBASICでは変数名の長さに制限がある場合があるので注意が必要です。

BASICでは、変数名の末尾に型を示す記号（型宣言文字）を付ける慣習があります。

記号データ型例
$文字列 (String)playerName$
%整数 (Integer)count%
&長整数 (Long Integer)largeNumber&
!単精度浮動小数点数 (Single Precision)average!
#倍精度浮動小数点数 (Double Precision)pi#

FreeBASICなどでは、DIM variable AS TYPE のように明示的に型を宣言することも推奨されます。

キーワードの大文字・小文字

BASICのキーワード（PRINT, IF, FOR など）は、大文字と小文字を区別しないことが多いですが、どちらかに統一すると読みやすくなります。一般的には、キーワードをすべて大文字で書くスタイルがよく見られます。 

' スタイル混在（あまり推奨されない）
print "Hello"
For i = 1 To 3 Print i
next i
' キーワード大文字（推奨されるスタイル例）
PRINT "Hello"
FOR i = 1 TO 3 PRINT i
NEXT i

行番号（古いBASICの場合）

古いBASICでは各行に行番号が必要でした。行番号は通常、10, 20, 30 のように10ずつ増やしていきます。これは、後から行を追加しやすくするためです（例: 10と20の間に15行を追加できる）。QBasicやFreeBASICでは行番号は必須ではありません。

まとめ

今回は、BASICプログラミングにおけるコメントの書き方と、読みやすいコードを書くためのスタイルについて学びました。

  • コメントは REM または ' で書く。
  • コードの意図を説明するためにコメントを活用する。
  • インデントやスペースを使ってコードの構造を分かりやすくする。
  • 変数名には意味のある名前をつけ、型宣言文字を使う（またはDIMで宣言する）。
  • キーワードの大文字・小文字を統一する。

きれいなコードを書く習慣は、プログラミング学習の早い段階で身につけることが大切です。今回学んだことを意識して、読みやすく、メンテナンスしやすいコードを目指しましょう！

参考情報

より詳しい情報や、他の言語でのコーディング規約については、以下のリソースも参考になります。

コメントを残す

メールアドレスが公開されることはありません。 ※ が付いている欄は必須項目です

前の記事

[BASICのはじめ方] Part3: Hello World…

次の記事

Geckodriver完全ガイド：SeleniumでのFire…