Plsql-developer removes Plsql-documentation?

[sjef]

I'm introducing PLSQLDoc as a documentary tool but have found an omission? After editing a package directly from package window, I added comments in front of "create or replace package xxx", genereated the document and compiled the object. All comments before create-statement are lost. Putting the comments after the create-statement doesn't make them show in the generated document. Any idea how to resolve this?

/* this will be removed by compiling the object
Read-only functions for module ANIMAL.

{%LINK .\7_Ontw\axan_general.pcb Detail. }
*/
CREATE OR REPLACE PACKAGE axan_general AS
/* this doesn't show in generated document.
Read-only functions for module ANIMAL.

{%LINK .\7_Ontw\axan_general.pcb Detail. }

%HIST 2003-09-09 JKO Initieel
*/

 

[Marco Kalter]

You can only use comments before the "create or replace" statement if you are saving the SQL script as a file. If you rely on the Oracle Dictionary to save the comments of your object, they cannot be placed before the statements that creates that object.

 

[sjef]

The problem just is Marco, PLSQL-developer gives possibility to edit the package by opening it in the object-panel. After editing you can recompile it directly into the database and debug the source. PLSQL-Doc however wants any comments placed before the "CREATE OR REPLACE PACKAGE" line and by doing so, losing any comments after compiling. Since this is standard ORACLE-behaviour, I expected PLSQL-Documentation tool to considder that, especially where it's an integrated plugin within the IDE.

 

[Marco Kalter]

If there is no comment before, then the first comment after "create or replace" will be used by the plsqldoc Plug-In for object documentation. See also chapter 4 in the User's Guide, specifically the first example.