ivotron
commented
13 years ago I like this one a lot. They even provide a rule-file for using it with checkstyle
The only thing I'd change is the javadoc style from this:
/** * Creates a column with the given name and type. The type should * be one of the values defined in SQLTypes. * * @param name name assigned to the column. * @param type data type * @return returns a reference to the object * @throws InvalidArgumentException when the argument passed to it is wrong */
to this:
/** * Creates a column with the given name and type. The type should * be one of the values defined in SQLTypes. * * @param name * name assigned to the column. * @param type * data type * @return * returns a reference to the object * @throws InvalidArgumentException * when the argument passed to it is wrong */
the second one is more readable.
Also, the blocking code convention I'd suggest for us to use is:
if (i == 0)
{
assertEquals("movieid", columns.get(i).getName());
}
else if (i == 1)
{
assertEquals("title", columns.get(i).getName());
}
that is, a brace in its own line.
Also, I'd like to suggest to avoid by all means using one-liners. I've noticed that code in the core has many of these one-line statements. For example, in DB2IndexMetadata Jeff and I were having a hard time trying to understand the following:
return whatIfOptimizer.whatIfOptimize(sql.toString())
.using(new DefaultBitSet(), new DefaultBitSet())
.toGetCost();
The guidelines that the convention specifies for conditionals (guideline 53) applies to the above:
"Complex conditional expressions must be avoided. Introduce temporary boolean variables instead"
Lastly, I think all methods, regardless of their simplicity, should be documented. This applies to methods included in unit tests, in which case the comment should provide a high-level description of what the test is checking, eg.:
/** * Checks that the ordering of columns on each table and index is * correct. The test makes sure that the elements on the list that * is returned by a container (eg.columns), when * iterated using theList.iterator()method, are in * the correct order. */ @Test public void testColumnOrdering() throws Exception { . . .
I think that actually following a coding convention is more important than picking one. Picking one is easy, following one and keeping the code in synch with it is the difficult part.
hsanchez
npolyzotis
We should have an explicit coding convention for our project.