web-dev-qa-db-ja.com

Oracle SQL Developerの「Generate DB Doc」関数の構文リファレンスはどこにありますか？

Oracle SQL Developer（私はv3.2を使用しています）には、データベースオブジェクトのドキュメントを生成する「DB Doc」と呼ばれる機能があります。主にそれを使用して、ストアドプロシージャ、関数、パッケージ、および型のドキュメントを生成します。ただし、使用する構文を説明するドキュメントは見つかりません。

私は/* ... */自分の手順/何でもすぐ上の行にコメントし、（JavaDocから借用して）@paramおよび@returnsステートメントですが、他に何が使えるかわかりません。たとえば、作成者、バージョン、変更されたデータなどのフィールドはありますか？

このサイト、Google、およびOracleのドキュメントを何度も検索しましたが、役に立ちませんでした！

oracleoracle-11g-r2plsqloracle-sql-developerdocumentation
5
Allan Lewis

コミュニティWikiの回答 最初は thatjeffsmith が残したコメントに基づいています：

これはそれがサポートするものの完全なリストです：

（ http://pldoc.sourceforge.net/maven-site/samples/sample1.sql から複製）

CREATE OR REPLACE
PACKAGE CUSTOMER_DATA
IS
/** 
* Project:         Test Project (<a href="http://pldoc.sourceforge.net">PLDoc</a>)<br/>
* Description:     Customer Data Management<br/>
* DB impact:       YES<br/>
* Commit inside:   NO<br/>
* Rollback inside: NO<br/>
* @headcom
*/

/**
* Record of customer data.
*
* @param id     customer ID
* @param name       customer name
* @param regno      registration number or SSN
* @param language   preferred language
*/
TYPE customer_type IS RECORD (
  id                        VARCHAR2(20),
  name                      VARCHAR2(100),
  regno                     VARCHAR2(50),
  language                  VARCHAR2(10)
);

/** Table of customer records. */
TYPE customer_table IS TABLE OF customer_type INDEX BY BINARY_INTEGER;

/**
* Gets customer by ID.
*
* @param p_id       customer ID
* @param r          record of customer data
* @throws no_data_found if no such customer exists
*/
PROCEDURE get_customer (
  p_id              VARCHAR2,
  customer_rec      OUT customer_type);

/**
* Searches customer by criteria.
*
* @param p_criteria record with assigned search criteria
* @param r_records  table of found customers <b>(may be empty!)</b>
*/
PROCEDURE get_by_criteria (
  p_criteria        customer_type,
  r_records         OUT customer_table);

/**
* Creates a customer record.
*
* @param customer_rec record of customer data
*/
PROCEDURE create_customer (
  customer_rec      customer_type);

/**
* Changes customer data.
*
* @param customer_rec record of updated customer data
*/
PROCEDURE update_customer (
  customer_rec      customer_type);

END;
/

PLDOCではすべてをサポートしています。GUIとCLIがあります。そこには3つのコードサンプルがあり、これらのサンプルにリストされているすべてを実行できるはずです。

1
user126897

PLSQLドキュメントの生成には [〜＃〜] pldoc [〜＃〜] を使用することをお勧めします。これはJavaDocに似ています（機能はわずかに制限されますが、@ return、@ throw、@ paramなどの基本があります）。

0
user28627