Hi,
one additional comment:
1. please use for variables and methods as descriptive names as possible.
2. the two most critical PMD rules for readability are, IMHO:
- only one return statement per method !!!
- code complexity, introduce as much private/protected helper
methods or external helper classes for more general tasks.
Those classes can be singleton classes if they load parameters
or contain static helper methods.
Kind regards, Joerg
> Hi all,
>
> here a short summary of my developer environment and coding conventions.
> Nothing is fixed, so if you have better arguments, we switch to another
> convention.
>
> Please have a look at the other sources to get a feeling for the
> conventions.
>
> IDE:
> Is eclipse, because it has excellent refactoring tools, code formatting.
> http://www.eclipse.org/
>
> Coding:
> PMD, PMD, PMD: please use the PMD rules to check your sources. I've
> started really late to use this tool, but if anyone can measure software
> quality, then the guys from the PMD project. Its amazing how clever
> those rules are, and there is an eclipse plugin.
> http://pmd.sourceforge.net/
>
> Make-Tool:
> Apache ANT, because its all in once: compiling, maintaining, documentation
> http://ant.apache.org/
>
> Documentation:
> DocBook-XML based on Jade, so this is pretty complex, i know, so i've a
> working environment and its not necessary that every developer has a
> working environment. So, you are on your own if you want get this stuff
> to work, but of course you can ask me.
>
> Kind regards, Joerg
--
Dipl. Chem. Joerg K. Wegner
Center of Bioinformatics Tuebingen (ZBIT)
Department of Computer Architecture
Univ. Tuebingen, Sand 1, D-72076 Tuebingen, Germany
Phone: (+49/0) 7071 29 78970
Fax: (+49/0) 7071 29 5091
E-Mail: mailto:we...@in...
WWW: http://www-ra.informatik.uni-tuebingen.de
--
Never mistake motion for action.
(E. Hemingway)
Never mistake action for meaningful action.
(Hugo Kubinyi,2004)
|
