Code Cleaning

Code that is to be released should be tested, proofread and spell checked and documented. It is best if these steps occur while the code is under development.

Testing

Testing is covered separately.

Non graphical code that is to be released should have 90% of the methods and roughly 90% of the basic blocks covered.

Developers with access to the metropolis workgroup on the Gigascale website can view the current coverage statistics at http://www.gigascale.org/metropolis/src/nightly/coverage.html.

Proofreading

Code that is to be publically released should be proofread.

Code should following a Coding Style

See also "How to Write Doc Comments for the Javadoc Tool," by Sun.

FIXME: chkjava The $METRO/util/testsuite/chkjava will warn about potential style problems.

FIXME: rmtabs

FIXME: rmtrailingspace

Spelling

FIXME: metrospell
All code that is released should be spell checked and not have spelling errors.
Documentation
Sun makes available a Doccheck doclet that checks for common problems in javadoc code, see http://java.sun.com/developer/earlyAccess/doccheck/
FIXME: make this part of the nightly build