PLSQL Code Editor Tricks – Preview Code Doc & Test Queries

thatjeffsmith SQL Developer 3 Comments

Tell Others About This Story:

Someone asked:

And here’s the answer – Yes!

First, let’s talk about PLDoc, and how it works in SQL Developer.

All caught up? Great.

Now let’s show you how to preview your fancy code doc before you go to generate the HTML.

Put your cursor on the item you want to see the doc on.

The key is to put the cursor on the object name in the code you want to gen the preview for.

The key is to put the cursor on the object name in the code you want to gen the preview for.

Right click, and select ‘Quick Documentation.’

Savvy?

Savvy?

But. Maybe you don’t want to have to click around – you want to see EVERYTHING.

But your cursor up top on the object name in the CREATE line.

No you can navigate around the generated HTML doc for the entire program!

No you can navigate around the generated HTML doc for the entire program!

Pretty cool, right?

I would recommend setting up some Snippets or Code Templates for making the code comments easier to insert in the first place. If it’s hard to doc – you don’t do it.

Same for testing…

Test Query

If you looked closely at the code editor context menu, there’s a ‘Test Query’ item on there.

Let’s say you have a cursor…and you’re too lazy to copy/paste it to a SQL Worksheet.

Highlight it, right click, Test Query.

Oh, Explain Plan too?

Oh, Explain Plan too?

Here’s the plan.

If you click the index name - we open the index for you.

If you click the index name – we open the index for you.

While this is a nice feature – I would recommend copying it to the SQL Worksheet if you’re going to do any serious work on it. Eventually you’ll exhaust the usefulness of the ‘Test Query’ dialog. But for quick and dirty – it works pretty well.

Related Posts Plugin for WordPress, Blogger...
Tell Others About This Story:

Comments 3

    1. thatjeffsmith Post
      Author
  1. I like this feture, but when I highlight the content of my package and right click on mouse then click on quick document, I did not see anything other than a null tooltip, by the way, prior to this I ‘ve run the generate db doc on sql developer db select link with ver 4.1.3, what do I miss?

Leave a Reply

Your email address will not be published. Required fields are marked *