変数/定数説明文

「変数/定数定義書」では、各モジュールの"Declaration"セクションで宣言された変数や定数の定義が出力されます。この情報をT'sDocの仕様書として出力するには、次の例のようにその変数/定数説明文(コメント)をコーディングします。


コード例

  ’他のモジュールにも有効な変数を宣言
  Public pstrFormName As String     ’/ フォーム名
  Public pstrReportName As String   ’/ レポート名
  Public pblnEndflg As Boolean      ’/ 終了フラグ
  ’ 終了ボタンが押されたら True
  ’このモジュール内だけで有効なエラー定数を定義
  Private Const ERR_TABLENOTEXIST = 3078  ’/ テーブル/クエリが見つからないエラー
  Private Const ERR_FILENOTEXIST = 53     ’/ ファイルが存在しないエラー
  Private Const ERR_NOCURRENTREC = 3021   ’/ カレントレコードなしエラー


仕様書出力例




注意事項

  • 変数/定数説明文は必ず ’/ でコメントを始めます。通常のコメントは定義書の対象とはされず、無視されます。

  • 変数/定数説明文として認識するのは、その変数/定数の宣言と同じ行の右側に記述されたものだけです。次のように、変数/定数の宣言されている行の上あるいは下に説明文が記述されている場合は、’/ で始まっていても変数/定数説明文として認識されません。

        ’/ テーブル/クエリが見つからないエラー
        Private Const ERR_TABLENOTEXIST = 3078

    また次のように、説明文が複数行に渡って記述されている場合にも、変数/定数の宣言されている行以外の説明文は認識されません。

        Private Const ERR_TABLENOTEXIST = 3078 ’/テーブル/クエリが
                                                                   ’/見つからないエラー

  • コード上、１行に複数の変数/定数が宣言されている場合、仕様書としては１行あたり１つの変数/定数に分けて、複数行に印刷されます。