Forum Stats

  • 3,757,895 Users
  • 2,251,291 Discussions
  • 7,869,963 Comments

Discussions

Generating function/procedure documentation

User_V8XR4
User_V8XR4 Member Posts: 3 Green Ribbon

Are there any plans to support generating function/procedure documentation like others?

for example: https://marketplace.visualstudio.com/items?itemName=xyz.plsql-language

Answers

  • Christian.Shay -Oracle
    Christian.Shay -Oracle Posts: 1,928 Employee
    edited Jul 22, 2020 1:58PM

    Thank you for the suggestion. All feedback on this forum is very valuable and we review it with each release it to determine our next features.

    Have you tried using XYZ.plsql-language side by side with our extension? (eg using XYZ to do pretty printing or commenting and our extension to do the rest?). If you have please let me know if that works or if it has issues or incompatibilities with our extension.

  • remduv
    remduv Member Posts: 3 Blue Ribbon
    edited Sep 17, 2021 1:36PM

    Hello Shay.

    I would also be interested in this possibility.

    I think it would be much easier if the expected "documentation templates" is defined by Oracle itself, instead of relying on people and tools each defining there own syntax (XYZ.plsql-language, pldoc, etc..)

    In Oracle SQL Developer tool, they're already supporting the "pldoc" format, see Jeff Smith blog for example : https://www.thatjeffsmith.com/archive/2012/03/javadoc-for-the-database-a-la-dbdoc-via-sql-developer/

    A cool feature is that you can generate HTML documentation pages directly from your PL/SQL code files.

    So it would be great if you could define the PL/SQL code documentation standard directly in the "Oracle Developer Tools for VS Code" extension .. best shot would be to stick with pldoc.

    Any chance to have this feature soon ?

    Thanks a lot