フロー説明文

「プロシージャ説明書」では、そのプロシージャの概略の処理フローが出力されます。この情報をT'sDocの仕様書として出力するには、次の例のようにそのフロー説明文(コメント)をコーディングします。


コード例

  ’/ 引数’Interval’の値によって処理を分岐します
  Select Case Interval
    Case 1
      ’// 1のときは1日後をセット
      dtmTempDate = DateAdd("d", 1, dtmDate)        ’/DateAdd関数で加算
    Case 2
      ’// 2のときは1週間後をセット
      dtmTempDate = DateAdd("ww", 1, dtmDate)
    Case 3
      ’// 3のときは1ヶ月後をセット
      dtmTempDate = DateAdd("m", 1, dtmDate)
    Case 4
      ’// 4のときは1年後をセット
      dtmTempDate = DateAdd("yyyy", 1, dtmDate)
    Case Else
      ’// 1〜4以外のときはエラーを生成
      ’/// エラー番号を設定
      lngErrNum = 10001
      ’/// エラーメッセージを設定
      strErrMsg = "引数’Interval’には1〜4の値を指定して下さい。"    
      ’エラーを発生させる
      Err.Raise lngErrNum, , strErrMsg
  End Select

  ’/ プロシージャの返り値に加算後の日付をセット
  GetDateLater = dtmTempDate


仕様書出力例




注意事項

  • プロシージャ説明書にフローとして印刷したいコメントは、 ’/ でコメントを始めます。通常のコメントはフローの対象とはされず、無視されます。

  • 「／(スラッシュ)」の数に応じてフロー説明文は段下げされます。
    例: ’//        ’///

  • コードの右側に ’/ を記述した場合もフロー説明文として解釈されます。プロシージャ内の変数や定数の右側に ’/ を記述しても「変数/定数定義書」には出力されませんので注意して下さい(「変数/定数定義書」は"Declaration"セクションのみを対象としています)。

  • フロー説明文は１つのプロシージャについて最大で約６０行程度にして下さい。使用されるプリンタの設定によって異なりますが、プロシージャ説明書の１ページ分を超えるフロー説明文はカットされます。