プロシージャ説明文

「プロシージャ説明書」では、そのプロシージャの処理の概要や引数、返値、宣言などのプロシージャのリファレンス情報が出力されます。この情報をT'sDocの仕様書として出力するには、次の例のようにプロシージャ説明文をコーディングします。


コード例

  Public Function GetDateLater(dtmDate As Date, Interval As Integer) As Date
  ’
  ’概要 指定日付に対して日付間隔を加算した日付を返します。
  ’
  ’引数 dtmDate : 加算対象の日付
  ’     Interval: 加算する日付間隔
  ’                   1:1日後  2:1週間後  3:1ヶ月後  4:1年後
  ’
  ’返値 加算後の日付を日付型変数として返します。
  ’
  ’備考 引数’Interval’に1〜4以外の値を指定したときは、
  ’     エラー番号1001を発生させます。


仕様書出力例




注意事項

  • 「概要」などはプロシージャ宣言行の下に記述し、行の左端から「’概要」のように記述して下さい。

  • 「概要」などの項目名とその説明文との間には必ず１文字以上のスペースを入れて下さい。
         (例：      ’概要<スペース>XXXXXXX  や  概要：<スペース>XXXXXXX など)

  • 「概要」や「引数」などの説明文を記述した１まとまりの部分は、すべて ’ (コメント)で始め、途中に ’ で始まらない空の行(リターンのみの行)を入れないようにして下さい。

  • 記述が複数行に渡っている「概要」や「引数」などの説明文については、それぞれの行の最後にスペース３文字が挿入された形で１行につなげられて印刷されます。