Bug 5262 - Automatic comment generation
Summary: Automatic comment generation
Status: RESOLVED FIXED
Alias: None
Product: JDT
Classification: Eclipse Project
Component: UI (show other bugs)
Version: 2.0   Edit
Hardware: All All
: P3 enhancement (vote)
Target Milestone: ---   Edit
Assignee: Erich Gamma CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2001-10-25 16:38 EDT by John Arthorne CLA
Modified: 2001-10-26 03:41 EDT (History)
0 users

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description John Arthorne CLA 2001-10-25 16:38:20 EDT
EC users have requested the following:

"VAJ has a nice feature that allows users to set default comments to be 
added at method and class creation time.  Other automatic boilerplate 
comments that could be added are, for example, copyright information at 
the top of the class. (Which, by the way is really annoying during 
development -- it would be nice to be able to hide that type of comment, 
either in my code or in somebody else's code)."

Or, when I create a new method I want to be able to automatically add
its javadoc: all the arguments, the return and the throw statements.

E.g, I write

int myMethod(int myArg1, int myArg2) throws Exception {}

now I press some magic key and get

/**
  @param myArg1 ......
  @param myArg2 ......
  @return .....
  @throw Exception .....
*/
  int myMethod(int myArg1, int myArg2) throws Exception {}
Comment 1 Martin Aeschlimann CLA 2001-10-26 03:41:17 EDT
This function is in the 2.0 Stream. (On methods).
It is is a quite raw state, but generates you the JavaDoc tag stubs as 
suggested.