Author: jfuerth
Date: Tue Mar 3 08:14:17 2009
New Revision: 2954
Modified:
wiki/JavaFormattingConventions.wiki
Log:
Tweaked license information
Modified: wiki/JavaFormattingConventions.wiki
==============================================================================
--- wiki/JavaFormattingConventions.wiki (original)
+++ wiki/JavaFormattingConventions.wiki Tue Mar 3 08:14:17 2009
@@ -14,7 +14,7 @@
* *2.2* We don't use gnumake, so ignore the GNUmakefile thing
- * *3.1.1* The non-javadoc introductory comment should now be the GPL
version 3 license notice for Architect and the BSD license for the SQLPower
library it depends on
+ * *3.1.1* The non-javadoc introductory comment should now be the GPL
version 3 license notice for all code that is part of an open SQL Power
project.
* *3.1.3* (4) Always put the log4j Logger declaration first, followed by
a blank line. No need to comment it.
@@ -74,6 +74,4 @@
Our preferred name for an event object in an event handler is
also "e". Therefore, you will often see catch blocks naming their
exceptions "ex" in Swing-related code to avoid confusion and naming
conflicts.
* *9.* (Interface naming) Additionally, avoid the temptation to use the
word "Interface" in an interface name, and the similar temptation to begin
an interface name with an I. Interface names should be given the cleanest,
most natural names possible. For instance, if you're creating an interface
and implementation for a beverage frobbing aparatus, you should name the
interface `BeverageFrobber`, and the implementation class
`BeverageFrobberImpl`. If there will be several implementations that would
benefit from extending an abstract base implementation, you would still
create a `BeverageFrobber` interface, then create an abstract class
`AbstractBeverageFrobber`, and extend it to the concrete classes named for
their particular purpose (`BlendingBeverageFrobber`,
`SippingBeverageFrobber`, `PouringBeverageFrobber`, and so on).
-
-
