PLSQL DOC Enhancemant Request

[orca777]

Hi,
there is a tag for exceptions which will be raised, interesting would be too a tag for exception which will be #handled/#cached

Do you think this is usefull?

Orca

 

[Marco Kalter]

Exceptions that can be raised are are of interest to the caller. You may need to handle them. The exceptions are actually part of the interface specification of the program unit and therefore need to be documented.

Exceptions that are handled within a program unit are not of interest to the caller. Or am I missing something?

------------------
Marco Kalter
Allround Automations

 

[orca777]

Hi,
Ok, what sense makes it to list the exception who are explicit raised in this procedure, but what's with the exceptions which are raised on deeper level and not catched?
For example, i want to express if a procedure which is called by a trigger catches all exceptions in ( when others )

so this functon/procedure is Exception-safe?

i hope i am not to complicate or to perfectly, let's discuss.

carl

probably your re right!
orca

[This message has been edited by orca777 (edited 21 August 2003).]

 

[Marco Kalter]

I assume you want to document user-defined exceptions that indicate a specified reason why the program unit failed (record locked, record does not exist, record already exists, validation errors, and so on). You can omit all other exceptions and treat them as 'unexpected errors'.

These user-defined exceptions can of course propagate from other calls within the program unit. These exceptions should either be handled or documented.

------------------
Marco Kalter
Allround Automations