10.13.2 プログラムコメントの抽出位置の指定
プログラムコメントが記述されているコメント行をプログラムコメント行と呼びます。このプログラムコメント行の検索場所と検索条件を[プログラムコメント抽出]タブの[抽出位置]で指定します。システム開発では,プロジェクトのコーディング規則によって,プログラムコメントの記述方法を定めるのが通例です。その規則が示すプログラムコメント行の場所を,検索場所と検索条件で指定します。
(1) プログラムコメント行の検索場所の指定
[抽出位置]の[プログラムコメント行の検索場所]で,プログラムコメント行がプログラム名段落の前にあるか,プログラム名段落のあとにあるかを指定します。デフォルトの設定では,[プログラム名段落の前]オプションボタンが選択されています。
[プログラム名段落の前]オプションボタンを選択すると,プログラム名段落(PROGRAM-ID)の1行前の行からソースファイルの先頭に向けて,検索条件を満たすコメント行が検索されます。ファイルの先頭,または見出し部の部見出し(IDENTIFICATION DIVISION)の前にある有効行に到達するまで検索されます。
[プログラム名段落の後]オプションボタンを選択すると,プログラム名段落(PROGRAM-ID)の次の行から見出し部の末尾まで,検索条件を満たすコメント行が検索されます。
- 注意事項
-
-
コメント行は,注記行,空白行,デバッグ行,または翻訳指令行です。
-
空白行,デバッグ行および翻訳指令行から抽出するコメント行の文字列は,空文字列("")になります。
-
(2) プログラムコメント行の検索条件の指定
[抽出位置]の[プログラムコメント行の検索条件]で,プログラムコメント行の検索条件を指定します。
(a) 空文字列でない最初のコメント行をプログラムコメント行として検出する
[抽出キー文字列で始まるコメント行]オプションボタンを選択して,[抽出キー文字列]を空にします。
この設定で解析/生成すると,検索場所で,最初の空文字列でないコメント行がプログラムコメント行として検出され,行の文字列がプログラムコメントとして抽出されます。
- IDENTIFICATION DIVISIONの前にプログラムコメントがある場合
-
-
「コメント1」をプログラムコメントとして抽出するための指定
- [プログラムコメント行の検索場所]:
-
[プログラム名段落の前]オプションボタンを選択する。
- [プログラムコメント行の検索条件]:
-
[抽出キー文字列で始まるコメント行]オプションボタンを選択する。
- [抽出キー文字列]:
-
何も指定しない。
-
- PROGRAM-IDの前後にプログラムコメントがある場合
-
-
「コメント1」をプログラムコメントとして抽出するための指定
- [プログラムコメント行の検索場所]:
-
[プログラム名段落の前]オプションボタンを選択する。
- [プログラムコメント行の検索条件]:
-
[抽出キー文字列で始まるコメント行]オプションボタンを選択する。
- [抽出キー文字列]:
-
何も指定しない。
-
「コメント2」をプログラムコメントとして抽出するための指定
- [プログラムコメント行の検索場所]:
-
[プログラム名段落の後]オプションボタンを選択する。
- [プログラムコメント行の検索条件]:
-
[抽出キー文字列で始まるコメント行]オプションボタンを選択する。
- [抽出キー文字列]:
-
何も指定しない。
-
- 注意事項
-
-
[抽出キー文字列で始まるコメント行]オプションボタンの代わりに,[抽出キー文字列で始まるコメント行の次行]オプションボタンを選択しても,結果は同じになります。
-
検索範囲内で空文字列でないコメント行が見つからない場合,プログラムコメントはなしとなり,プログラムコメント行の文字列は空文字列となります。
-
(b) 抽出キー文字列で始まる最初のコメント行をプログラムコメント行として検出する
[抽出キー文字列で始まるコメント行]オプションボタンを選択して,[抽出キー文字列]に抽出キーを指定します。
この設定で解析/生成すると,検索場所で,最初の抽出キー文字列で始まるコメント行がプログラムコメント行として検出され,抽出キー文字列の直後から行末尾までの文字列がプログラムコメントとして抽出されます。
-
「コメント1」をプログラムコメントとして抽出するための指定
- [プログラムコメント行の検索場所]:
-
[プログラム名段落の前]オプションボタンを選択する。
- [プログラムコメント行の検索条件]:
-
[抽出キー文字列で始まるコメント行]オプションボタンを選択する。
- [抽出キー文字列]:
-
「抽出キー」を指定する。
-
「コメント2」をプログラムコメントとして抽出するための指定
- [プログラムコメント行の検索場所]:
-
[プログラム名段落の後]オプションボタンを選択する。
- [プログラムコメント行の検索条件]:
-
[抽出キー文字列で始まるコメント行]オプションボタンを選択する。
- [抽出キー文字列]:
-
「抽出キー」を指定する。
- 注意事項
-
-
検索範囲内に抽出キー文字列で始まるコメント行が見つからない場合,プログラムコメントはなしとなり,プログラムコメント行の文字列は空文字列となります。
-
抽出キー文字列のあとに空白以外の文字がないコメント行の場合,プログラムコメントはなしとなり,プログラムコメント行の文字列は空文字列となります。
-
(c) 抽出キー文字列で始まる最初のコメント行の次行をプログラムコメント行として検出する
[抽出キー文字列で始まるコメント行の次行]オプションボタンを選択して,[抽出キー文字列]に抽出キーを指定します。
この設定で解析/生成すると,検索場所で,最初の抽出キー文字列で始まるコメント行の次の行がプログラムコメント行として検出され,行の文字列がプログラムコメントとして抽出されます。
-
「コメント1」をプログラムコメントとして抽出するための指定
- [プログラムコメント行の検索場所]:
-
[プログラム名段落の前]オプションボタンを選択する。
- [プログラムコメント行の検索条件]:
-
[抽出キー文字列で始まるコメント行の次行]オプションボタンを選択する。
- [抽出キー文字列]:
-
「抽出キー」を指定する。
-
「コメント2」をプログラムコメントとして抽出するための指定
- [プログラムコメント行の検索場所]:
-
[プログラム名段落の後]オプションボタンを選択する。
- [プログラムコメント行の検索条件]:
-
[抽出キー文字列で始まるコメント行の次行]オプションボタンを選択する。
- [抽出キー文字列]:
-
「抽出キー」を指定する。
- 注意事項
-
-
検索範囲内に抽出キー文字列で始まるコメント行が見つからない場合,プログラムコメントはなしとなり,プログラムコメント行の文字列は空文字列となります。
-
抽出キー文字列で始まる行はコメント行でも,その次の行がコメント行でない,またはコメント文字列が空文字列のコメント行である場合があります。その場合,プログラムコメントはなしとなり,プログラムコメント行の文字列は空文字列となります。
-
(d) プログラム名段落から特定の行目にあるコメント行をプログラムコメント行として検出する
[プログラム名段落から指定行目の位置にあるコメント行]オプションボタンを選択して,[行目]にプログラム名段落から何行目のコメント行かを指定します。
この設定で解析/生成すると,検索場所で,プログラム名段落から指定行目にあるコメント行がプログラムコメント行として検出され,行の文字列がプログラムコメントとして抽出されます。
-
「コメント1」をプログラムコメントとして抽出するための指定
- [プログラムコメント行の検索場所]:
-
[プログラム名段落の前]オプションボタンを選択する。
- [プログラムコメント行の検索条件]:
-
[プログラム名段落から指定行目の位置にあるコメント行]オプションボタンを選択する。
- [行目]:
-
「6」を指定する。
-
「コメント2」をプログラムコメントとして抽出するための指定
- [プログラムコメント行の検索場所]:
-
[プログラム名段落の後]オプションボタンを選択する。
- [プログラムコメント行の検索条件]:
-
[プログラム名段落から指定行目の位置にあるコメント行]オプションボタンを選択する。
- [行目]:
-
「3」を指定する。
- 注意事項
-
-
コメント行(注記行,空白行,デバッグ行,または翻訳指令行)でない行は,行数にはカウントされません。
-
指定行目のコメント行が検索範囲外のコメント行の場合,プログラムコメントはなしとなり,プログラムコメント行の文字列は空文字列となります。
-
指定行目のコメント行が空白行,デバッグ行,または翻訳指令行の場合,プログラムコメントはなしとなり,プログラムコメント行の文字列は空文字列となります。
-
関連項目