[izpack-devel] Good practice for the Eclipse "Problem"-Tab...
Klaus.Bartz at coi.de
Fri Dec 1 17:18:34 CET 2006
I do not agree with you that it is a good practice to ignore eclipse warnings.
Yes, most of it are related to missing or corrupt java doc.
May be we have not the time and/or not the knowledge to create sufficient java doc comments
for old code. But we can do it for our new code. Also for getter and setter. It is possible to use
template for simple situation. You need a <ctrl> <shift> J grip... And you do not forget the java doc
at methods where it is really needed. It is contents of the language and it is recommanded to
comment all non-private methods. Not all developer uses the source as docu.
If we do it not, the code will be not better.
May be it is possible to use implicit developing rules if the developing group consists of one or
two people, but not with nearly twenty. One makes no java comment, the other do not attend
the dtd (or writes no) and some others do not write docu for the features or do not update it
at changes. Not forget different coding styles...
To supress such chaos it is needed to say something about it from time to time (it is also addressed
From: izpack-devel-bounces at lists.berlios.de [mailto:izpack-devel-bounces at lists.berlios.de]On Behalf Of Markus Schlegel
Sent: Friday, December 01, 2006 9:49 AM
To: izpack-devel at lists.berlios.de
Subject: [izpack-devel] Good practice for the Eclipse "Problem"-Tab...
I read some posts about this the last few days and like to share a few thoughts about this.
When I switched from JBuilder to Eclipse last summer with my project, Eclipse showed up with several thousands Problems. First I thought, "oh dear, there is so much wrong with my code? Lets fix all of this and I get more reliable code (higher quality)...". When I got deeper into this, I realized, that most of those problem warnings are irrelevant. It just makes no sense to add a foll blown javadoc comment to a simple selfexplainatory method. What happens most in such cases is, that the programmer then simply adds a dummy comment (no real explaination, its there only to quiten eclipse). And in fact I saw this in many projects. It just makes no sense to rewrite in javadoc what is written in the method declaration already. Often it's also much better and sufficient to write a good class comment. Then iot makes no sense to rewrite the comment for the methods again.
The other point that often happens with such (dummy) comments is, that - because they are irrelevant - they will not be maintained when developing the code.
What I like a lot more, are comments inside the code block (as it is done in IzPack already very well I argue). But this can not be tested with eclipse of corse...
So maybe you should concentrate on real problems, open points and fixing bugs rather than quitening eclipse's problem tab.
-------------- next part --------------
An HTML attachment was scrubbed...
More information about the izpack-devel