10.14.2 節コメントの抽出位置の指定
節コメントが記述されているコメント行を節コメント行と呼びます。この節コメント行の検索場所と検索条件を［節コメント抽出］タブの［抽出位置］で指定します。システム開発では，プロジェクトのコーディング規則によって，節コメントの記述方法を定めるのが通例です。その規則が示す節コメント行の場所を，検索場所と検索条件で指定します。
- 〈この項の構成〉
(1) 節コメント行の検索場所の指定
［抽出位置］の［節コメント行の検索場所］で，節コメント行が節見出しの前にあるか，節見出しのあとにあるかを指定します。デフォルトの設定では，［節見出しの前］オプションボタンが選択されています。
![[図データ]](GRAPHICS/ZUAPS200.GIF)
［節見出しの前］オプションボタンを選択すると，節見出しの1行前の行からソースファイルの先頭に向けて，検索条件を満たすコメント行が検索されます。有効行が出現するまで検索されます。
![[図データ]](GRAPHICS/ZUAPS210.GIF)
［節見出しの後］オプションボタンを選択すると，節見出しの次の行から節の末尾まで，検索条件を満たすコメント行が検索されます。
![[図データ]](GRAPHICS/ZUAPS220.GIF)
- 注意事項
-
-
コメント行は，注記行，空白行，デバッグ行，または翻訳指令行です。
-
空白行，デバッグ行，および翻訳指令行から抽出するコメント行の文字列は，空文字列（""）になります。
-
(2) 節コメント行の検索条件の指定
［抽出位置］の［節コメント行の検索条件］で，節コメント行の検索条件を指定します。
![[図データ]](GRAPHICS/ZUAPS230.GIF)
(a) 空文字列でない最初のコメント行を節コメント行として検出する
［抽出キー文字列で始まるコメント行］オプションボタンを選択して，［抽出キー文字列］を空にします。
この設定で解析／生成すると，検索場所で，最初の空文字列でないコメント行が節コメント行として検出され，行の文字列が節コメントとして抽出されます。
![[図データ]](GRAPHICS/ZUAPS240.GIF)
-
「コメント1」を節コメントとして抽出するための指定
- ［節コメント行の検索場所］：
-
［節見出しの前］オプションボタンを選択する。
- ［節コメント行の検索条件］：
-
［抽出キー文字列で始まるコメント行］オプションボタンを選択する。
- ［抽出キー文字列］：
-
何も指定しない。
-
「コメント2」を節コメントとして抽出するための指定
- ［節コメント行の検索場所］：
-
［節見出しの後］オプションボタンを選択する。
- ［節コメント行の検索条件］：
-
［抽出キー文字列で始まるコメント行］オプションボタンを選択する。
- ［抽出キー文字列］：
-
何も指定しない。
- 注意事項
-
-
［抽出キー文字列で始まるコメント行］オプションボタンの代わりに，［抽出キー文字列で始まるコメント行の次行］オプションボタンを選択しても，結果は同じになります。
-
検索範囲内で空文字列でないコメント行が見つからない場合，節コメントはなしとなり，節コメント行の文字列は空文字列となります。
-
(b) 抽出キー文字列で始まる最初のコメント行を節コメント行として検出する
［抽出キー文字列で始まるコメント行］オプションボタンを選択して，［抽出キー文字列］に抽出キーを指定します。
この設定で解析／生成すると，検索場所で，最初の抽出キー文字列で始まるコメント行が節コメント行として検出され，抽出キー文字列の直後から行末尾までの文字列が節コメントとして抽出されます。
![[図データ]](GRAPHICS/ZUAPS250.GIF)
-
「コメント1」を節コメントとして抽出するための指定
- ［節コメント行の検索場所］：
-
［節見出しの前］オプションボタンを選択する。
- ［節コメント行の検索条件］：
-
［抽出キー文字列で始まるコメント行］オプションボタンを選択する。
- ［抽出キー文字列］：
-
「抽出キー」を指定する。
-
「コメント2」を節コメントとして抽出するための指定
- ［節コメント行の検索場所］：
-
［節見出しの後］オプションボタンを選択する。
- ［節コメント行の検索条件］：
-
［抽出キー文字列で始まるコメント行］オプションボタンを選択する。
- ［抽出キー文字列］：
-
「抽出キー」を指定する。
- 注意事項
-
-
検索範囲内に抽出キー文字列で始まるコメント行が見つからない場合，節コメントはなしとなり，節コメント行の文字列は空文字列となります。
-
抽出キー文字列のあとに空白以外の文字がないコメント行の場合，節コメントはなしとなり，節コメント行の文字列は空文字列となります。
-
(c) 抽出キー文字列で始まる最初のコメント行の次行を節コメント行として検出する
［抽出キー文字列で始まるコメント行の次行］オプションボタンを選択して，［抽出キー文字列］に抽出キーを指定します。
この設定で解析／生成すると，検索場所で，最初の抽出キー文字列で始まるコメント行の次の行が節コメント行として検出され，行の文字列が節コメントとして抽出されます。
![[図データ]](GRAPHICS/ZUAPS260.GIF)
-
「コメント1」を節コメントとして抽出するための指定
- ［節コメント行の検索場所］：
-
［節見出しの前］オプションボタンを選択する。
- ［節コメント行の検索条件］：
-
［抽出キー文字列で始まるコメント行の次行］オプションボタンを選択する。
- ［抽出キー文字列］：
-
「抽出キー」を指定する。
-
「コメント2」を節コメントとして抽出するための指定
- ［節コメント行の検索場所］：
-
［節見出しの後］オプションボタンを選択する。
- ［節コメント行の検索条件］：
-
［抽出キー文字列で始まるコメント行の次行］オプションボタンを選択する。
- ［抽出キー文字列］：
-
「抽出キー」を指定する。
- 注意事項
-
-
検索範囲内に抽出キー文字列で始まるコメント行が見つからない場合，節コメントはなしとなり，節コメント行の文字列は空文字列となります。
-
抽出キー文字列で始まる行はコメント行でも，その次の行がコメント行でない，またはコメント文字列が空文字列のコメント行である場合があります。その場合，節コメントはなしとなり，節コメント行の文字列は空文字列となります。
-
(d) 節見出しから特定の行目にあるコメント行を節コメント行として検出する
［節見出しから指定行目の位置にあるコメント行］オプションボタンを選択して，［行目］に節見出しから何行目のコメント行かを指定します。
この設定で解析／生成すると，検索場所で，節見出しから指定行目にあるコメント行が節コメント行として検出され，行の文字列が節コメントとして抽出されます。
![[図データ]](GRAPHICS/ZUAPS270.GIF)
-
「コメント1」を節コメントとして抽出するための指定
- ［節コメント行の検索場所］：
-
［節見出しの前］オプションボタンを選択する。
- ［節コメント行の検索条件］：
-
［節見出しから指定行目の位置にあるコメント行］オプションボタンを選択する。
- ［行目］：
-
「4」を指定する。
-
「コメント2」を節コメントとして抽出するための指定
- ［節コメント行の検索場所］：
-
［節見出しの後］オプションボタンを選択する。
- ［節コメント行の検索条件］：
-
［節見出しから指定行目の位置にあるコメント行］オプションボタンを選択する。
- ［行目］：
-
「3」を指定する。
- 注意事項
-
-
コメント行（注記行，空白行，デバッグ行，または翻訳指令行）でない行は，行数にはカウントされません。
-
指定行目のコメント行が検索範囲外のコメント行の場合，節コメントはなしとなり，節コメント行の文字列は空文字列となります。
-
指定行目のコメント行が空白行，デバッグ行，または翻訳指令行の場合，節コメントはなしとなり，節コメント行の文字列は空文字列となります。
-
関連項目