[Cdk-devel] review of vflib (aka writing clean CDK code)

[Egon W. <ego...@gm...>]

Hi Rajarshi, Mark,

I have had a look at the vflib branch, and note that the code is aimed
at the standard module; like all new code, but for code in this module
in particular, should adhere to CDK's 'stable' standards...

(BTW, there is a Nightly at [0] which has been running on an older
version of the patch)

The below are some guidelines, please feel free to ask me or search
the cdk-devel archives for the details.

1. clean JavaDoc

You can use DocCheck to check that your clean has clean JavaDoc:

ant -f javadoc.xml doccheck

A common error is missing periods at the end of first sentences in the
JavaDoc. The first sentence is important to get right, per JavaDoc
standards.

2. no PMD warning (or with a good excuse)

ant -f pmd.xml

3. unit test coverage

Each module has a test suite MfooTests, which points to a Test class
doing coverage testing... new unit tests classes must be added to this
suite, MstandardTests for the vflib patch. The coverage testing class
will then check that all new code is tested.

I note missing tests of NodePair and State.

Then these issues have been resolved, I'll look at the
code/functionality itself.

Egon

0.http://pele.farmbio.uu.se/nightly-vflib/


-- 
Post-doc @ Uppsala University
http://chem-bla-ics.blogspot.com/