RE: Ran PMD against source tree in branch
"Philippe Back \(High Octane\)" <[email protected]>
| Newsgroups | gmane.comp.java.orm.simpleorm |
|---|---|
| Message-ID | <[email protected]> |
Ok, I am used to source control, no worries.
About the if()s
I do see multiple variants in the code:
if (cond) statement
if (cond)
statement;
if (cond)
statement;
another statement; // confusing !
if (cond) { statement }
Well, two comments here:
a) first version is not debugger friendly (stepping)
b) third version is really misleading. (I saw several instances of this and
this may be latent bugs awaiting).
c) I do value consistency, so my vote for
if (x) {
y;
z;
}
d) there are also throws spanning several lines and a { is useful for
matching the end of the statement, not having it is a pain.
All these are code reading related, but is a primary asset in any code base.
Nevertheless, this is nitpicking and I am the way it is, just will have my
own thingy in a corner to be happy :-)
So, I am not gonna commit changes as such but what I do see in the field is
that people run PMD more and more on codebases and this is also part of
evaluation for some open source libraries.
the braces thing is one of the basic rules of PMD and we get warnings all
over the place.
Also lots of: OnlyOneReturn
So, I'll have to recheckout the whole thing and redo the changes.
I am going on holidays tomorrow, so do not expect anything before 18/8
Kind Regards and thanks for the comments,
/Philippe
_____
From: [email protected] [mailto:[email protected]] On Behalf
Of Anthony Berglas
Sent: jeudi 24 juillet 2008 3:38
To: [email protected]
Subject: Re: [SimpleORM] Ran PMD against source tree in branch
PS. Of course immediately before any check in you MUST also do an
update and check the unit tests. So
svn upd
ant
svn diff
svn commit -m "Meaningful message"
Anthony
At 11:35 AM 24/07/2008, Anthony Berglas wrote:
>Hello Phil,
>
>The redundant {} are a matter of personal choice as Franck says. I
>personally don't like them, clutter. But basically I think this
>sort of detail is up to each developer. If you change some code
>then format it the way you like, but don't change other peoples code
>just for formatting.
>
>Adding @Overrides is good. They should go everywhere. I
>personally like them for implementing abstract methods too -- adds clarity.
>
>Parameters not used and methods not called are worthy of
>investigation. Please make a list.
>
>Imports are a pain. I like *, but IDEs "add value" by
>enumeration. But not important either way.
>
>Whatever you do, make sure you svn diff your current version before
>committing. There should not be too many non-significant
>changes. I run my eye over the diff list.
>
>If you have created too much noise then please revert and start
>again. Otherwise check it in.
>
>But the best place to start is the test cases. They need work, and
>improving them builds your understanding of SimpleOrm. Extra data
>in TestUte would be a valuable contribution.
>
>Anthony
>
>At 10:57 PM 23/07/2008, Philippe Back \(High Octane\) wrote:
>
>>Hi Anthony, Franck,
>>
>>I ran PMD and there were several warnings.
>>
>>Lots of 'if's without {}es. I added these in my local copy.
>>
>>Also, there were places where there were no @Override in front of
>>overriden methods. I added these in my local copy.
>>
>>I also noticed that there are places were there are @Override in
>>front of interface methods. Maybe a leftover.
>>
>>Some method parameters are not used, so I added a ### comment in
>>the method javadoc in my local copy.
>>
>>There are also several unused imports that I removed.
>>
>>Also corrected some typos.
>>
>>Would you have an issue with me commiting these changes ?
>>
>>KR
>>/Philippe
>>
>>No virus found in this outgoing message.
>>Checked by AVG.
>>Version: 7.5.524 / Virus Database: 270.5.3/1565 - Release Date:
>>21/07/2008 18:36
>>
>
>Dr Anthony Berglas, HYPERLINK
"mailto:anthony%40berglas.org"[email protected] Mobile: +61 4 4838 8874
>Just because it is possible to push twigs along the ground with ones nose
>does not necessarily mean that is the best way to collect firewood.
Dr Anthony Berglas, HYPERLINK
"mailto:anthony%40berglas.org"[email protected] Mobile: +61 4 4838 8874
Just because it is possible to push twigs along the ground with ones nose
does not necessarily mean that is the best way to collect firewood.
No virus found in this incoming message.
Checked by AVG.
Version: 7.5.524 / Virus Database: 270.5.3/1565 - Release Date: 21/07/2008
18:36
No virus found in this outgoing message.
Checked by AVG.
Version: 7.5.524 / Virus Database: 270.5.3/1565 - Release Date: 21/07/2008
18:36