チュートリアル: コード ドキュメンテーション

Visual Expert は、ソースコードのドキュメントを作成できます。

最終的には、アプリケーション全体のすべてのオブジェクトとその依存関係を詳細に記述した、非常に包括的な HTML ドキュメントになります。これは、コードのメンテナンス、レビューを目的とし、ナレッジ トランスファーのためのリファレンス マニュアルとして使用できます。

詳細は以下のサンプルをご覧ください。

Visual Expert でソースコードのドキュメントを作成するには?

  1. Visual Expertプロジェクトを開き、リボンメニュー内の [ドキュメント] タブをクリックします。
    コード ドキュメンテーションメニュー
  2. [すぐに生成] をクリックすると、デフォルトまたは最新の設定を使用してドキュメントの生成が開始されます。
    Visual Expertでコード・ドキュメンテーションを生成
  3. [スケジュールの管理] をクリックすると、ドキュメント生成をスケジューリングできます。
    Visual Expert でコードのドキュメント化をスケジュールします。

    [スケジュールの管理]では、定期的に(毎日、毎週、毎月)またはマシンがアイドルのときに、ドキュメント作成をスケジューリングできます。

    Visual Expertを使用したコード・ドキュメンテーションのスケジュール管理
  4. [ビューを開く] ボタンをクリックすると、生成された最新のドキュメントが開かれます。
    Visual Expert で最新のコード・ドキュメントを見る
  5. Visual Expertでは、英語、フランス語、日本語、スペイン語の 4ケ国の言語をサポートしています。
    選択された言語でドキュメントが生成されます。
    コード・ドキュメンテーションのために複数の言語から選択
  6. デフォルトでは、Visual Expert はプロジェクト全体のドキュメントを生成します。
    [コンテンツの調整] オプションを使用すると、ドキュメントの範囲を絞り込むことができます。 詳細は、事前設定 > コンテンツの調整。以下を確認してください。.
    コードドキュメントにフィルタを適用
  7. [ドキュメント設定] をクリックすると、[ドキュメントの生成] ダイアログが開かれ、ドキュメントをカスタマイズできます。
    高度な設定でコードドキュメントをカスタマイズ

高度な設定でコードドキュメントをカスタマイズ

[ドキュメントの生成] ダイアログには、次の2つのサブセクションが設定されています。

1. 設定

このセクションでは、ドキュメントを生成する前に、パス、内容、スタイル、テンプレート、言語を指定できます。

コード・ドキュメンテーションのパス、内容、スタイル、テンプレート、言語を示す

ドキュメントのパス:

ドキュメントを保存するためのパスを設定します。
パスを変更するには、[フォルダーをブラウズ...] ボタンをクリックしてください。

スタイル:

Visual Expertでは、HTMLドキュメントのカスタム スタイルを作成できます。
[スタイル編集...]をクリックして、新しいスタイルを作成します。ドロップダウンで「Novalys Default Style」をカスタムスタイルで変更し、ドロップダウンリストを開いて使用するスタイルを指定できます。

テンプレート:

ドキュメントのテンプレートを選択します。

内容:

デフォルトでは、Visual Expert はプロジェクト全体のドキュメントを生成します。
プロジェクトの一部のみのドキュメントを作成したい場合は、このドロップダウンで [選択アイテムのみ] オプションを選択します。

プロジェクトの選択された項目のコード・ドキュメントを作成します。

メイン ビューで選択されたコンポーネントのみのドキュメントが生成されます。

プロジェクトの選択された項目のコード・ドキュメントを生成します。

言語:

ドキュメントの言語を英語、フランス語、スペイン語、日本語から選択します。

[コンテンツの調整] ボタン:

開かれる [ドキュメント設定] ダイアログでは、ドキュメントに含めるコンポーネント タイプを選択できます。

コード・ドキュメンテーションでコンポーネントをタイプ別にフィルタリングする

上記のように、必要に応じて選択したコンポーネント タイプごとにドキュメントを作成できます。
[OK] 'をクリックすると、変更が保存されます。

2. スケジュラー

このサブセクションでは、毎日、毎週、毎月、または特定の時間にドキュメントをスケジューリングできます。

毎日、毎週、毎月、または特定の時間にコードの文書化をスケジュールします。

Visual Expert は、パス、スタイル、テンプレート、コンテンツ、言語の現在の設定に準じてスケジュールされたドキュメントを生成します。

[ドキュメントの生成] ダイアログの下部には、4つのボタンが用意されています。それぞれの使い方は以下の通りです。

ドキュメントセンターで利用可能なオプション

PB + SQLサーバープロジェクト用に作成したリファレンス ドキュメントのサンプルがホームページにあります。

PB + SQL Serverプロジェクトのサンプルドキュメント

コード レビュー ドキュメント

Visual Expertはまた、コード レビュードキュメントを生成できます。

以下のサンプルをご参照ください。

このようなドキュメントを作成できます。

コード レビュー ドキュメントは、以下の手順で作成します。

  1. リボン メニュー内の [ドキュメンテーション] タブを選択し、[ドキュメント設定] をクリックして [ドキュメントの生成] ダイアログを開きます。
    Visual Expert を使用してコードレビューレポートを生成
  2. テンプレートとして [コード レビュー] を選択します。
    Visual Expert を使用してコードレビューレポートを生成
  3. [すぐに生成] ボタンをクリックして、コード レビュー ドキュメントの生成を開始します。
    Visual Expert を使用してコードレビューレポートを生成

[コンテンツの調整] ボタン:

必要なコンポーネントの種類や部分のみを選択することで、コード レビュー ドキュメントの内容をフィルタリングできます。それには、[コンテンツの調整] ボタンをクリックして、[ドキュメント設定] ダイアログを開きます。

コードレビュー文書の内容をコンポーネントの種類でフィルタリングします。

例えば、以下の選択は、未使用のプロシージャとコメントが記述されていないプロシージャのコード レビュー ドキュメントのみを生成します。

未使用およびコメントされていないプロシージャのコードレビューレポートの生成

PB + SQLサーバープロジェクト用に作成したリファレンス ドキュメントのサンプルがホームページにあります。

未使用およびコメントされていないプロシージャのコードレビューレポートの生成

次の記事もご参照ください。