Oracle

在哪裡可以找到 Oracle SQL Developer 的“Generate DB Doc”函式的語法參考?

  • November 21, 2019

Oracle SQL Developer(我使用的是 v3.2)有一個名為“DB Doc”的特性,它可以為數據庫對像生成文件。我主要想用它來為我的儲存過程、函式、包和類型生成文件。但是,我找不到任何文件,描述我應該使用什麼語法。

我已經確定我應該/* ... */在我的過程/其他內容的正上方使用註釋,並且(通過從 JavaDoc 借用)我已經成功使用了@param@returns語句,但我不確定我還能使用什麼。例如,是否有作者、版本、修改數據等欄位?

我已經對該站點、Google 和 Oracle 的文件進行了多次搜尋,但無濟於事!

社區 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。那裡有三個程式碼範例,您應該能夠執行這些範例中列出的任何操作。

引用自:https://dba.stackexchange.com/questions/27035