COBOL言語のコメントと良いコメントの書き方とは？｜基礎ガイド

COBOL（コボル）言語で頻繁に活用されるコメントとその書き方とは

基礎-コメントの書き方-イメージ

COBOL（コボル）言語のコメントの書き方

プログラムに書かれているコメントは、そのプログラムで実現している処理の概要や、なぜその処理をしているのか理由を説明するなど、コンピュータに理解させるために書かれるものではなく、プログラムの書き手を含めたプログラムを活用する人の理解のために書かれています。

このようなコメントも立派なプログラムの一部になるため、プログラミング言語ごとにその書き方も違います。さらにCOBOL（コボル）言語の場合は、固定形式と自由形式で書き方が変わりますので、まずはコメントの書き方、使用例からしっかり理解するようにしましょう。

コメントの書き方：

固定形式：標識領域（7桁目）に「*」または「/」を記述します。（※）

自由形式：「*>」を記述します。記述する桁に特に制限はありません。（※）

（※）記号（*、/、*>）以降、その行は全てコメントとして扱われます。

使用例（固定形式、COBOL_SAMPLE01）：

基礎-コメントの書き方-使用例

実行結果：

使用例（自由形式、COBOL_SAMPLE02）：

基礎-コメントの書き方-使用例

実行結果：

COBOL（コボル）言語のコメントの使い方

コメントはコンピュータに対してではなく、人に対して書かれるものであると先程説明しましたが、一般的にコメントには大きく2つの使い方があります。

1つ目はメモです。自分を含めたプログラムを見る人に、そのプログラムで何を実現しようとしているのか情報提供する事で、長い複雑なプログラムを隅から隅まで読まなくても内容を理解できるようにサポートします。

自分で書いたプログラムにメモは必要ないと思われる方もいらっしゃるかもわかりませんが、プログラムは記述量が多くなったり、月日が経つと、意外と何をやっていたか忘れてしまうものです。自分のためにもメモを活用するようにしましょう。

2つ目はデバッグです。自分のプログラムにある不具合を探し取り除く作業をデバッグといいますが、この不具合を探し取り除くために、一部の処理をコメント化して読み飛ばしたり、本来必要のないDISPLAY文を組み込む事で処理途中の値を確認したり、いつでも確認できるようにコメント化しておくというような使い方ができます。

COBOL（コボル）言語で良いコメントを書くための注意事項

ここまでの説明は、コメントの書き方、使い方をご紹介しました。ここからは良いコメントの書き方について考えていきましょう。ところで良いコメントとはどういうものでしょうか？それは、実際にそれを活用する人がメリットを感じるものという事になるのではないでしょうか。では実際にコメントを活用する人のメリットを考え、良いコメントとは何かを考えてみましょう。

（コメントのメリット）

なぜこの項目がこの値の範囲で利用されているのかなど、注意を促すコメントや単純にプログラムを読むだけではわからない処理の内容をコメントとして残す事で、プログラムの調査・改修時に、プログラムを理解するスピードが上がる。
いつどういう目的・背景でその処理を作成したかがわかる事で、プログラムの修正ミス等を未然に防げる。
良く使う処理にコメントが書かれる事で、新しいプログラムを作成する際に、以前のプログラムを流用しやすくなる。
エラー処理など、後で書けばいい機能をメモとして残せるため、作業を分割して行いやすい。

このように良いコメントとは、開発生産性や調査作業などの効率につながるような「書き方」であり、プログラムを活用する人を「サポート」する役割を持つものである事がわかると思います。ですので、コメントを書く際は、これらの読み手を意識した、意味のあるコメントを書く事を意識するようにしましょう。

COBOL（コボル）言語のコメントの活用法

最後にコメントの活用法をご紹介します。プログラム開発は大抵複数人で行う事になりますが、コメントの書き方をある程度決めておく事で、非常に効率よくプログラムを作成したり読む事ができます。

ここではCOBOL（コボル）言語でよく使われるファイル入出力処理を例にご紹介します。処理単位にコメントを入れておく事で、実際にプログラムで何をやっているのか、そのポイントがわかりやすくまとまっている事に気付くと思います。

サンプルプログラム（COBOL_SAMPLE03）：

> ----------------------------------------------
*>   プログラム名  ファイル入出力処理サンプル
*>   プログラムID  Cobol_sample03
*>   バージョン    1.0.0
*>   作成日       作成者
*>   YYYY/MM/DD  XXXXXXXX
*>   更新日       更新者    更新概要
*>   YYYY/MM/DD  XXXXXXXX XXXXXXXXXXXXXXXXXX
*> ----------------------------------------------
IDENTIFICATION                 DIVISION.
PROGRAM-ID.                   Cobol_sample03.
ENVIRONMENT                    DIVISION.
INPUT-OUTPUT                   SECTION.
FILE-CONTROL.
   SELECT IN01-FILE
       ASSIGN TO "test_in.txt"
       ORGANIZATION IS LINE SEQUENTIAL.
   SELECT OUT01-FILE
       ASSIGN TO "test_out.txt"
       ORGANIZATION IS LINE SEQUENTIAL.
*> ----------------------------------------------
*> データ部
*> ----------------------------------------------
DATA                  DIVISION.
FILE                 SECTION.
FD  IN01-FILE.
01  IN01.
 03  IN-KOUMOKU1             PIC X(12).
FD  OUT01-FILE.
01  OUT01.
 03  OUT-KOUMOKU1            PIC X(12).
*> ----------------------------------------------
*> 作業場所節 
*> ----------------------------------------------
WORKING-STORAGE              SECTION.
*>  変数定義
01 SAMPLE-DATA.
 03 KOUMOKU1     PIC X(12) VALUE "Hello Cobol!".
*> ----------------------------------------------
*> 手続き部
*> ----------------------------------------------
PROCEDURE                   DIVISION.
SAMPLE-RTN                  SECTION.
*>  初期処理
   PERFORM  INIT-RTN.
*>  主処理
   PERFORM  MAIN-RTN
*>  終了処理
   PERFORM  END-RTN.
   STOP RUN.
SAMPLE-EXIT.
*> ----------------------------------------------
*> 初期処理 
*> ----------------------------------------------
INIT-RTN                   SECTION.
  OPEN  INPUT  IN01-FILE.
  OPEN  OUTPUT  OUT01-FILE.
  PERFORM  READ01-RTN.
INIT-EXIT.
*> ----------------------------------------------
*> ファイル読込処理
*> ----------------------------------------------
READ01-RTN                   SECTION.
  READ  IN01-FILE            AT  END
   GO  TO  READ01-EXIT
  END-READ.
READ01-EXIT.
*> ----------------------------------------------
*> 主処理
*> ----------------------------------------------
MAIN-RTN                    SECTION.
  MOVE KOUMOKU1 TO OUT-KOUMOKU1.
  PERFORM  WRITE01-RTN.
  DISPLAY "ファイル出力完了".
MAIN-EXIT.
*> ----------------------------------------------
*>  ファイル出力処理
*> ----------------------------------------------
WRITE01-RTN                   SECTION.
  WRITE  OUT01.
WRITE01-EXIT.
*> ----------------------------------------------
*>  終了処理
*> ----------------------------------------------
END-RTN                     SECTION.
  CLOSE  IN01-FILE.
  CLOSE  OUT01-FILE.
END-EXIT.