Description Thomas von Haugwitz 2006-01-26 07:32:49 EST

Hi,

what about including a "history"-function for javadoc @param comments. one would not have to enter the same comments for the exact same parameters (the names and types would have to be the same) in similar functions and classes all over again. 

e.g.

/**
 *  @param parentCompData
 *            a description for parentCompData
 *  @param childCompData
 *            a description for childCompData
 */
public void someFunction(CompData parentCompData, CompData childCompData)
{
}

now you have another function with parameters using the same types CompData and parameternames parentCompData and childCompData

a history function would now suggest a previously entered comment for parentCompData or take the first available one....


/**
 *  @param parentCompData   a description for parentCompData
 *  @param childCompData    ...
 *
 */
public void someOtherFunction(CompData parentCompData, CompData childCompData)
{
}

what do u think about it ?

greetings

tvh








Also, if one would create a new class which inherits another class, the constructors is always added to the newly created class with a comment like

public class SomeClass
extends SomeOtherClass

/**
 *
 */
 public SomeClass()
 {
     super();
 }

SomeOtherClass contained the following pretty well documented constructor

public class SomeOtherClass
{
    /**
     *  Constructor.
     *
     *  a class to do stuff and some other cool things.
     *  uses a special interface with a whole bunch of
     *  superimportant features
     */
    public SomeOtherClass()
    {
    }

it would be cool if that comment would be added to inherited constructors as well. Also, this comment could be used as a document-template.

public class SomeClass
extends SomeOtherClass
{
    /**
     *  Constructor.
     *
     *  a class to do stuff and some other cool things.
     *  uses a special interface with a whole bunch of
     *  superimportant features
     */
     public SomeClass()
     {
        super();
     }

or using functions