<bug>

Start with this (notice that there is no closing comment):

    /** One two |three
    public void addBuyer(BuyerDataBeanAdapter buyerDataBeanAdapter)
    {

Press Return.  The result is:

    /** One two
     *
     */ three
    public void addBuyer(BuyerDataBeanAdapter buyerDataBeanAdapter)
    {

Notice that 'three' shows up after the comment is closed.

</bug>

<recommendation>

I sometimes use one-line java doc comments:

    /** One-line javadoc comment. */
    public void addBuyer(BuyerDataBeanAdapter buyerDataBeanAdapter)
    {

OK, its not a full javadoc, but its better than nothing and its quicker
than doing a full java doc when you are in a hurry.

But if this one-liner gets split with a return anywhere within the line,
the whole line should probably move down.  In other words, starting with
this:

    /** One two |three */
    public void addBuyer(BuyerDataBeanAdapter buyerDataBeanAdapter)
    {

Pressing return should end with this:

    /**
     * One two
     * three
     * @param buyerDataBeanAdapter
     */
    public void addBuyer(BuyerDataBeanAdapter buyerDataBeanAdapter)
    {

Aside from 'three' showing up inside the comment :), 'One two' is pushed
down a line, and the missing javadoc tags are added.

What you get now (with IDEA 636) is this:

    /** One two
     * three */
    public void addBuyer(BuyerDataBeanAdapter buyerDataBeanAdapter)
    {

</recommendation>

cc


_______________________________________________
Eap-bugs mailing list
[EMAIL PROTECTED]
http://lists.jetbrains.com/mailman/listinfo/eap-bugs

Reply via email to