Bugs item #494035, was opened at 2001-12-16 17:24
You can respond by visiting: 
http://sourceforge.net/tracker/?func=detail&atid=402704&aid=494035&group_id=31602

Category: ejbdoclet
Group: None
Status: Open
Resolution: None
Priority: 5
Submitted By: Brill Pappin (brill)
Assigned to: Nobody/Anonymous (nobody)
Summary: Java Coding Standards not used

Initial Comment:
Example file attached.

The generated classes are very messy and do not 
conform to standard coding standards.

1. The java.lang.* package is imported into all 
generated classes, this should not be explicitly 
imported. 
2. in the attached example, first "if" statement 
missing block, method signature: 
equals(Object)::boolean.
3. Explicit declaration of such classes as 
java.lang.String (or Object) not required and 
obfuscates the code.
4. Explicit declaration of classes in the same 
package. Once again, bad coding practice, and 
obfuscates code.

If there are people who do like their classes output 
in this way (as I'm sure there must be), then I 
suggest you add a switch to the ant task so the 
output can conform (or not) to a cleaner, standard 
format.

In fact, I'll do the work for it too!

For more information, see:
http://java.sun.com/docs/codeconv/html/CodeConvTOC.doc
.html

in particular, the sections:
7 - Statements
9 - Naming Conventions

With experience I have found a few more items that 
tend to make the code clearer, which is important 
when you expect other developers to be 
looking/working with it (and who doesn't now?).


----------------------------------------------------------------------

You can respond by visiting: 
http://sourceforge.net/tracker/?func=detail&atid=402704&aid=494035&group_id=31602

_______________________________________________
Xdoclet-devel mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/xdoclet-devel

Reply via email to