Well, I don't use the block comment feature, and sometimes I even have to use vi to comment out blocks.

So I guess I'd be happier with single-line comments a la

+ // Check for null here because _brokers is a weak reference collection
                  if ((broker != null) && (!broker.isClosed()))
                    broker.close();

But I'm not really strongly biased toward either style.

So +.07 for single- or multi-line // comments, even though a paragraph of // comments is a bit distracting.

Craig

On Feb 2, 2007, at 3:09 PM, Kevin Sutter wrote:

For some reason, my reply seems to have gotten lost... I don't care which
way we do it.  I'm flexible.  If we decide to go with the single line
comments, then I'll change the two blocks that Patrick pointed out in the
original note.

P.S. I kind of side with Geir on this. I just use Eclipse to highlight the whole chunk and then do Ctrl-/ to toggle single line comments. This works regardless of the type of comments being used. But, like I said, I don't
care.

On 2/2/07, Patrick Linskey <[EMAIL PROTECTED]> wrote:

Hi,

To date, almost all of the OpenJPA code uses single-line-style comments inside method blocks, instead of multi-line comments. I prefer sticking
with this convention; my excuse is that it makes it easier to comment
out blocks of code during debugging, since you can use /*-style comments
when debugging with impunity if there are no /*-style comments in the
code. But really, it's probably just personal bias.

Thoughts?

-Patrick

+                /* Check for null here because _brokers is a
> weak reference
> +                collection */
>                  if ((broker != null) && (!broker.isClosed()))
>                      broker.close();



> -            if ((_flags & FLAG_FLUSH_REQUIRED) != 0)
> +            /* If a flush is desired (based on input parm),
> then check if the
> +             * "dirty" flag is set before calling flush().
> +             */
> +            if ((flush) && ((_flags & FLAG_FLUSH_REQUIRED) != 0))
>                  flush();
>              detachAllInternal(call);

> -        catch(IllegalStateException ise) {
> -            /*
> -             * An IllegalStateException is expected. Nothing
> to do here.
> -             */
> -        }

_____________________________________________________________________ __ Notice: This email message, together with any attachments, may contain information of BEA Systems, Inc., its subsidiaries and affiliated entities, that may be confidential, proprietary, copyrighted and/or legally privileged, and is intended solely for the use of the individual or entity named in this message. If you are not the intended recipient, and have received this message in error, please immediately return this
by email and then delete it.


Craig Russell
Architect, Sun Java Enterprise System http://java.sun.com/products/jdo
408 276-5638 mailto:[EMAIL PROTECTED]
P.S. A good JDO? O, Gasp!

Attachment: smime.p7s
Description: S/MIME cryptographic signature

Reply via email to