Bug 29733 - Additional suggestion providers: editor keystrokes, help, i18n
Additional suggestion providers: editor keystrokes, help, i18n
Status: NEW
Product: editor
Classification: Unclassified
Component: Hints & Annotations
3.x
Sun All
: P2 with 1 vote (vote)
: TBD
Assigned To: tasklist-issues@contrib
tasklist-issues@contrib
: I18N
Depends on:
Blocks:
  Show dependency treegraph
 
Reported: 2002-12-26 00:26 UTC by Torbjorn Norbye
Modified: 2007-03-05 21:24 UTC (History)
0 users

See Also:
Issue Type: ENHANCEMENT
:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Torbjorn Norbye 2002-12-26 00:26:52 UTC
It would be nice to have additional suggestion
modules which provide more suggestions to help the
user. Here are some ideas:

- javadoc.  Looks for errors in the javadoc
(missing javadoc on   public methods, or
incomplete javadoc (missing @param or @return,  
wrong name in @param, etc.)
- help. When the current node changes, and there
are help topics  
available, list them.
- editor keystrokes. Listens for keystrokes in the
editor, and compares them to the abbreviations
table. If for example it notices that you're tying
"S y s t e m . o u t . p r i n t l n ( " it should
add the tip "Next time, just type "sout " in the
editor and it will insert System.out.println("|");
!"    Likewise, it might notice you typing import
statements and telling you to use alt+shift+i, or
it might notice you commenting out a block by hand
and telling you how to use the comment-out
feature. etc.

The last module (editor keystrokes) is an example
of a module which tries to make our features
available to non-experts. There are tons of hidden
goodies in this IDE. If you for example are hand
editing serialVerUID fields, tell the user about
the serialver module. etc. etc. etc.
Comment 1 Torbjorn Norbye 2003-01-20 16:47:57 UTC
javadoc support has been added
Comment 2 Torbjorn Norbye 2003-02-17 21:49:49 UTC
An i18n module could warn you about string literals in your source
code not tagged with NOI18N. Check if that marker is a convention or
just a Sun/NetBeans thing.
Comment 3 Torbjorn Norbye 2003-02-21 05:56:06 UTC
This is an enhancement, not a task.
Comment 4 Torbjorn Norbye 2003-03-06 17:32:49 UTC
I took a quick stab at creating a Help provider, but ran into a
problem: I can obtain HelpCtx for nodes and topcomponents when
activated nodes etc. change, BUT, HelpCtx only has a single method -
showHelp. That's not what I want. I was hoping I would be able to
obtain a HelpSet from the HelpCtx so I can look up the help title or
something like that. But to do that I'll need do to a lot more work,
probably duplicating code in the Help module (and what's worse, I may
not be able to share the initialized helpsets so they'll be
initialized twice).

So I abandoned this work for now. If we're going to get some kind of
dynamic help display, I think we need improvements in the help api.
(Btw, I noticed that almost no nodes had interesting help ids
attached, so for this feature to be useful more help should be written
and attached to objects.)


By use of this website, you agree to the NetBeans Policies and Terms of Use. © 2012, Oracle Corporation and/or its affiliates. Sponsored by Oracle logo