COBOLのコメントとTODO管理をマスター!初心者向け可読性向上ガイド
生徒
「COBOLのプログラムを書いてみたのですが、後で見返すと何をしているか自分でも分からなくなってしまいます。どうすればいいですか?」
先生
「それはプログラミングを始めたばかりの人が必ずぶつかる壁ですね。解決策は、人間向けのメモである『コメント』を上手に使うことです。」
生徒
「メモですか?プログラムの中に日本語を書いても大丈夫なんですか?」
先生
「もちろんです!今日は、効率的なコメントの書き方と、やり残した仕事を忘れないための『TODO管理』のコツをお話ししますね。」
1. コメントとは何か?
COBOLにおけるコメントとは、プログラムの中に書き込む「人間向けのメモ」のことです。コンピューターはこのコメント部分を無視して実行するため、どんなに日本語で詳しく説明を書いても、システムの動きには影響しません。
プログラミング未経験の方に例えると、「お料理のレシピ本に書き込む自分専用のコツ」のようなものです。材料や手順というプログラムの命令の横に、「ここは焦げやすいので注意」「強火で3分」といった補足情報を書いておくことで、久しぶりに料理をするときでも失敗しなくなりますよね。
COBOLでは、行の特定の場所(7列目)に「*(アスタリスク)」を書くことで、その行全体をコメントにすることができます。このシンプルな機能が、複雑なシステムを守る大きな役割を果たします。
2. 段階的なコメント挿入の重要性
コメントは、プログラムが完成した後にまとめて書くものではありません。大切なのは、プログラムを作っていく工程に合わせて段階的に挿入していくことです。これを怠ると、作っている最中に「あれ、ここは次は何をするんだっけ?」と迷子になってしまいます。
まず最初に「これからやるべきことの骨組み」を日本語のコメントだけで書いてみましょう。これを日本語プログラミングと呼ぶこともあります。骨組みができあがってから、そのコメントの下に実際のCOBOLの命令を書き足していくのです。この方法なら、パソコンを触ったことがない方でも、物語を組み立てるようにプログラムを作っていくことができます。
3. 最初に書くべき見出しコメントの例
プログラムの冒頭には、必ず「このプログラムは何のためにあるのか」という情報を書きましょう。これをプログラムヘッダーと呼びます。作成日、作成者、修正履歴などを残しておくのは、プロの世界では常識です。
*****************************************************************
* プログラム名:給与計算処理
* 作成者 :田中 太郎
* 作成日 :2026年2月3日
* 概要 :社員ごとの基本給に手当を加えて合計を算出する。
*****************************************************************
IDENTIFICATION DIVISION.
PROGRAM-ID. SALARY-CALC.
実行結果は以下の通りです(画面には何も表示されません)。
(コメントなので出力はありません)
このように枠線で囲むと、後から見たときにとても読みやすくなります。
4. TODO管理でやり残しを防ぐコツ
プログラムを開発していると、「今は一旦飛ばして後で詳しく作りたい部分」や「今は仮の数字を入れているけれど、後で本物のデータに差し替えたい部分」が出てきます。そんな時に使うのがTODO(トゥードゥー)というメモです。
コメントの中に「TODO: 」という目立つ印を付けておくことで、作業のやり残しを検索してすぐに見つけられるようになります。お買い物に行く前に書く「買うものリスト」を、プログラムの中に埋め込んでおくような感覚です。これにより、うっかりミスで未完成のままシステムを動かしてしまう悲劇を防ぐことができます。
5. TODOコメントを使った実践的なコード
具体的に、未完成の部分にTODOを入れる書き方を見てみましょう。まだ計算式が決まっていないけれど、とりあえず他の部分を作りたい時の例です。
PROCEDURE DIVISION.
* TODO: 2026年度の最新税率が発表されたら修正すること
MOVE 0.10 TO WK-TAX-RATE.
* TODO: ここに詳細な計算ロジックを追加予定
DISPLAY "現在の仮税率は " WK-TAX-RATE " です。".
STOP RUN.
実行結果は以下の通りです。
現在の仮税率は .10 です。
TODOを残しておくことで、数日後に作業を再開したとき、自分がどこから手をつければいいのかが瞬時に分かります。
6. 良いコメントと悪いコメントの違い
何でもかんでもコメントを書けばいいというわけではありません。悪いコメントの典型は「見ればわかることをそのまま書く」ことです。例えば「1を足す」という命令の横に「1を足す」と書くのは、あまり意味がありません。
- 悪い例:
ADD 1 TO CNT. * CNTに1を足す - 良い例:
ADD 1 TO CNT. * 出席者の人数をカウントアップ
良いコメントは、「何をしているか」ではなく「なぜそれをしているか」という理由や意図を教えてくれます。これを意識するだけで、あなたの書くプログラムの可読性はぐんと向上します。
7. 専門用語のやさしい解説
ここで、少し難しいIT用語を初心者向けに解説します。
- 可読性(かどくせい):プログラムが人間にとってどれだけ読みやすいかという指標。コメントが適切だと可読性が高まります。
- ロジック:プログラムの処理の手順や理屈のこと。迷路を抜けるためのルートのようなものです。
- メンテナンス:一度作ったシステムを、不具合を直したり新機能を入れたりして守り続けていくこと。
- アスタリスク:星印(*)のこと。COBOLではこれを特定の場所に書くと「ここから右はメモですよ」という合図になります。
8. 処理の区切りを明確にするコメント術
長くなってしまったプログラムを読みやすくするには、段落の区切りに目立つコメントを入れるのが効果的です。本に章や節があるように、プログラムにも区切りを作ってあげましょう。これにより、全体の見通しが良くなります。
*---------------------------------------------------------------
* 1. データ入力セクション
*---------------------------------------------------------------
DISPLAY "名前を入力してください:".
ACCEPT IN-NAME.
*---------------------------------------------------------------
* 2. 挨拶表示セクション
*---------------------------------------------------------------
DISPLAY "こんにちは、" IN-NAME "さん!".
実行結果は以下のようになります(「田中」と入力した場合)。
名前を入力してください:
田中
こんにちは、田中さん!
このように区切り線を入れることで、どこからが別の仕事なのかが一目で分かるようになります。これは初心者が最初に覚えるべき「思いやりのテクニック」です。
9. デバッグ作業とコメントの関係
プログラムがうまく動かないときに原因を探す作業をデバッグと言います。このときにもコメントは大活躍します。怪しい動きをしている部分の命令を「コメント」に変えて一時的に動かなくすることをコメントアウトと呼びます。
プログラムを消してしまうのは勇気がいりますが、コメントアウトならいつでも元の状態に戻せます。パソコンに不慣れなうちは、一度に全部を書き直すのではなく、コメントアウトを使いながら少しずつ正解に近づいていくのが、上達の近道です。
10. コメントは未来の自分へのプレゼント
最後にお伝えしたいのは、コメントは「未来の自分」を助けるために書くものだということです。3ヶ月後の自分は、今の自分が何を考えていたかをすっかり忘れています。その時の自分が困らないように、今の自分が親切にヒントを残しておくのです。
COBOLは銀行などの大切な場所で長く使われる言語です。あなたが書いたコメントが、10年後の誰かを助けることもあります。丁寧なコメントと計画的なTODO管理で、誰からも愛される「美しくて読みやすいプログラム」を目指しましょう!