在哪里可以找到 Oracle SQL Developer 的“生成数据库文档”功能的语法参考？

Question

Oracle SQL Developer（我使用的是 v3.2）有一个名为“DB Doc”的特性，它为数据库对象生成文档。我主要想用它来为我的存储过程、函数、包和类型生成文档。但是，我找不到任何文档来描述我应该使用什么语法。

我已经确定我应该/* ... */在我的程序/任何东西上方的行上使用注释，并且（通过从 JavaDoc 借用）我已经成功地使用了@param和@returns语句，但我不确定我还能使用什么。例如，是否有作者、版本、数据修改等字段？

我已经对这个站点、谷歌和 Oracle 的文档进行了多次搜索，但都无济于事！

Answer 1

_{社区 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。那里有三个代码示例，您应该能够执行这些示例中列出的任何操作。