diff --git a/DEVELOPERS-GUIDE.html b/DEVELOPERS-GUIDE.html index 25e88a7d4..718c6e417 100644 --- a/DEVELOPERS-GUIDE.html +++ b/DEVELOPERS-GUIDE.html @@ -8,7 +8,7 @@

The Jakarta Commons Lang Package

Developers Guide

-$Id: DEVELOPERS-GUIDE.html,v 1.5 2003/08/14 00:08:14 bayard Exp $
+$Id: DEVELOPERS-GUIDE.html,v 1.6 2003/08/14 00:21:23 scolebourne Exp $
[Introduction] [Package Structure] [Utility Classes] @@ -102,12 +102,19 @@ to small!) to enhance readability of the generated Javadoc.

It should be supported with an explanation within a normal paragraph.

Exception throwing

-

When throwing an exception to indicate a bad argument, always throw +

When throwing an exception to indicate a bad argument, always try to throw IllegalArgumentException, even if the argument was null. Do not throw -NullPointerException.

+NullPointerException. (Obviously, you should document what the code actually does!)

+ +

Deprecations

+

When deprecating a method or class include a clear reference to when the method will be deleted. +This should be of the form 'Method will be removed in Commons Lang 3.0.'.

Language used in code/comments

-

It has been decided to casually standardize on US-English. To avoid misplaced jeers of 'americanisation', the people making this decision largely write in non-US-English. However, it's not something to get worked up about. Lots of spelling differences will creep in all over.

+

It has been decided to casually standardize on US-English. +To avoid misplaced jeers of 'americanisation', the people making this decision largely write in non-US-English. +However, it's not something to get worked up about. +Lots of spelling differences will creep in all over.