[jdom-interest] Checkstyle and RuntimeExceptions (fwd)

[bob mcwhirter]

It's a (fwd) from jakarta-commons dev list, but just another datapoint
regarding documentation of runtime exceptions...

	-bob


---------- Forwarded message ----------
To: commons-dev at jakarta.apache.org
From: Steve Cohen <stevecoh1 at attbi.com>
Reply-To: Jakarta Commons Developers List <commons-dev at jakarta.apache.org>
Date: Tue, 30 Apr 2002 21:47:55 -0500
Subject: Checkstyle and RuntimeExceptions

In Joshua Bloch's "Effective Java" he makes a point of stating that writers 
of Javadoc comments should be ESPECIALLY interested in documenting runtime 
exceptions that are NOT listed in the throws clause (as in fact, they're not 
required to be).  Makes good sense to me, since you're not required to list 
these, how else are you going to warn users of your class that such may be 
thrown?