When creating packages in a database, only the lines following the "Create or replace package body" line are inserted into the database. If this tool will ever have the ability to generate documentation directly from the database (or even better, on-the-fly), it would seem that it would need to draw tags from the source in the db, which would need the tags to be inside the package body.
Thoughts? It doesn't match javadoc as much, but it is how the code is saved...
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
If you use the first method, the comment will be lost after installing the package into database.
Thus, it's not recommended.
If you use any of the remaining methods, all will be OK.
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
When creating packages in a database, only the lines following the "Create or replace package body" line are inserted into the database. If this tool will ever have the ability to generate documentation directly from the database (or even better, on-the-fly), it would seem that it would need to draw tags from the source in the db, which would need the tags to be inside the package body.
Thoughts? It doesn't match javadoc as much, but it is how the code is saved...
There are three methods to place package comments, see "The Package Comment" in
http://pldoc.sourceforge.net/docs/Users_Guide/content.html#Commenting rules
If you use the first method, the comment will be lost after installing the package into database.
Thus, it's not recommended.
If you use any of the remaining methods, all will be OK.
My bad. Cool!