The PL/Doc View displays appropriate PL/Doc for all database objects. The PL/Doc syntax here is very close to Javadoc and can be used in all Stored Procedures.
All with the COMMENT ON statement defined comments for tables, views and their columns are also displayed in the PL / Doc View dialog.
The following list gives an overview of all keywords and their meaning:
@author | Documents the author of the PL/Doc and the associated source code. |
@deprecated | Marks the associated source code as deprecated. That means it should not be used anymore. Usually, an explanation which functionality should be used instead is added. |
@exception | Documents which exceptions can occur. |
@param | Documents a parameter of a function or a procedure. |
@return | Documents the return value of a function. |
@see | Defines a cross reference to another database object. |
@since | Documents to which version the functionality was added. |
Furthermore, all HTML tags can be used in a PL/Doc although they should not be used to much. Writing PL/Doc can be quite time-consuming otherwise.
Click the keyword countand see how PL/Doc View changes its content.
Click any database object name (in this case the T_CUSTOMER word) in Stored Procedure Editor and see how PL/Doc View changes its content.