留意事項
動作上の留意点
- T'sDocは、Accessデータベース(.accdb、.mdb)のみの対応です。Accessプロジェクト(.adp)には対応していません。
- 仕様書作成中に一度エラーが発生すると、仕様書の作成を再実行したとき、あるいはT'sDocを再起動したときに「このマシンのほかのセッションによってロックされているので、更新できませんでした。」というメッセージが表示され、T'sDocの操作ができなくなることがあります。このような場合は、いったんAccess自体を終了し、再起動後、仕様書作成の対象データベースからエラーの原因を取り除いたあとで、T'sDocの処理を再実行してください。このエラーは主に、リンク先のデータベースが存在しないリンクテーブルがある場合や、存在しないテーブルを参照するクエリがある場合に発生します。ただし、作成する仕様書の種類によっては、そのような状況にあってもエラーが発生しない場合もあります。
- 個々のオブジェクトにセキュリティが設定されている場合、解析に必要な権限がないと仕様書を作成することはできません。その場合には仕様書の解析中に予期しないエラーが発生する可能性があります。仕様書を作成するデータベースにはすべての権限を与えておいてください。
- リンクテーブルのあるデータベースの仕様書を作成する場合には、リンク元のデータベースが、リンク情報通りの場所(ドライブやフォルダ)にある状態にしてから作業を始めてください。
- 仕様書を作成するデータベースの、テーブル/クエリ/フォーム/レポート/マクロ/モジュールそれぞれにおいてオブジェクトが1つもない場合には、それらに関連する仕様書をチェックして仕様書作成処理を実行しても処理後に自動的にチェックが外されます。また、印刷やPDF出力、HTML出力、Excelワークシート出力、CSVファイル出力も対象外となります。ただし、次の仕様書については、印刷するデータが1つもなくてもチェックは外されず、仕様書印刷画面の[プレビュー]ボタンも使用可能な状態になりますが、実際には印刷・プレビューされません。
- コントロール一覧表(フォーム/レポート)
- プロシージャ一覧表(フォーム/レポート/モジュール)
- プロシージャ説明書(フォーム/レポート/モジュール)
- 変数/定数定義書(フォーム/レポート/モジュール)
- ソースリスト(フォーム/レポート/モジュール)
- フォーム/テーブル・クエリ関連表
- レポート/テーブル・クエリ関連表
- コントロールソース関連表(フォーム/レポート)
仕様書上の留意点
- ご使用になるパソコンの「プリンタのプロパティ」や「通常使うプリンタ」の設定、あるいはプリンタの機種やプリンタドライバによっては、印刷される仕様書の用紙のサイズや向きがT'sDoc本来のものとは違ってしまう可能性があります。初めて印刷されるときは、すべての仕様書についてまずプレビュー(仕様書印刷画面で仕様書名のボタンをクリックします)を行って用紙の設定を確認してください。
T'sDocの仕様書は、すべて次のような基本設定になっています。これと違っていた場合には、Accessの[ページ設定]によって設定を変更し、仕様書のレポートの[上書き保存]を行ってください。
- 用紙サイズ..............A4
- 用紙の向き..............ヨコ
- 余白(上)..............18.01mm
- 余白(下)..............8.01mm
- 余白(左)..............12.5mm
- 余白(右)..............12.5mm
また、目次およびソースリストのレポートは、2列印刷になっています。ページ設定ダイアログの[レイアウト]タブで、次のように設定を行ってください。
- 列数..............2
- 行間隔..............0cm
- 列間隔..............1cm
- 幅..............13cm
- 高さ..............0.399cm
- 実寸..............OFF
- 印刷方向..............左から右へ
- 表紙や各仕様書のヘッダには仕様書作成元のデータベースファイル(.accdb、.mdb)のデータベースプロパティの内容が印刷されます。仕様書一式を出力する際には、データベースプロパティのうち、「タイトル」、「サブタイトル」、「作成者」、「会社名」、「コメント」をぜひ忘れずに設定しておいてください。
- フォームまたはレポートのコントロール一覧表を作成する場合、Access標準添付以外のカスタムコントロールを使用していると予期しないエラーが発生する可能性があります(そのような状況での動作確認は行っていません)。
- フォーム/テーブル・クエリ関連表およびレポート/テーブル・クエリ関連表では、フォームやレポートのレコードソースプロパティが空の場合や、このプロパティにクエリやテーブル名ではなくSQL文が直接設定されているものは除外されます。ここで、SQL文が設定されているかどうかの判断は"SELECT"句と"FROM"句があるかどうかで行っていますので、このプロパティに"SELECT"という語句と"FROM"という語句の両方が含まれた名前のテーブルやクエリが指定されている場合にも対象から除外されます。
- プロシージャ説明書や変数/定数定義書でより詳細な仕様書を作成するためには、T'sDoc独自の記述ルールに従ってモジュールのコードを記述する必要があります。詳細はモジュール記述ルールについてを参照してください。
- ソースリストでは、解析元のコードの各行で、左端に文字がある場合(スペースやタブで段下げされていない場合)はその行全体が太字で印刷されます。また、その行が"_"(アンダースコア)で次の行に継続している場合にはその行も太字で印刷されます。
- ソースリストでは、"Declaration"セクションの"Option Compare Database"や"Option Explicit"しかないモジュールについては出力されません。