Oracleコード ドキュメントでテーブルとカラムのコメントを表示する方法

Visual Expert (VE) 2020では、Oracleのテーブルとカラムへのコメントの追加がサポートされました。
これらのコメントは、特定のテーブルやカラムの目的を文書化して説明するために不可欠なものです。

Visual Expert Oracle コード パーサーがそれらを解析するようになりました。コメントは、VEのUIや Oracle PL/SQL コード ドキュメンテーション に表示されます。.

メイン ビューでコメントをチェック

  • テーブルのコメントを表示するには、ツリービューのルートにある [Tables] を選択します。
    ナビゲーションバーで、[すべてのテーブル] をクリックします。
    各テーブル名の横にコメントが表示されます(利用可能な場合)。

    ツリービューのルートでテーブルを選択

  • メイン ビューのテーブルをクリックして、ソース コード ビュー内の関連する コメントを確認します。

    ソースコードビューでテーブルのコメントをチェック

  • カラムのコメントを確認するには、テーブルを選択して、ナビゲーションバーの [カラム] をクリックします。

    コラムのコメントをチェック

 

ドキュメントのコメントをチェック

Visual Expertを使用して Oracle PL/SQLコードのドキュメントを生成する方法 については、この記事を参照してください。

ドキュメントの生成後、以下の手順に従ってください。

  • Visual Expertで生成されたコード ドキュメンテーションを開きます。
  • ダッシュボードで [テーブル] をクリックすると、アプリケーションのテーブル リストが表示されます。

    Oracle PL/SQLドキュメントでコメントをチェック

  • テーブルのコメントは「説明」欄に表示されます。

    Oracle PL/SQLドキュメントでコメントをチェック

  • カラムのコメントを確認するには、テーブル一覧からテーブル名をクリックします。
    テーブルの詳細ページ内で、カラムのコメントは「説明」欄に表示されます。

    Oracle PL/SQLドキュメントでコメントをチェック

 

Visual Expert 2020, Oracle, Check Comments, Code Documentation