[jdom-interest] Exception documentation

Bryan Thale bryan.thale at motorola.com
Mon Apr 29 17:12:54 PDT 2002


Elliotte Rusty Harold wrote:

> 2. All methods that throw a JDOM-specific runtime exception such as
> IllegalNameException should include that exception in their throws
> clause, even though the Java compiler does not require this.

Just my opinion, but I kinda like the convention that all explicitly thrown
exceptions be described in javadoc @throws statements but only checked exceptions be
included in the throws clause of the method definition.  The javadoc tells me
everything I *might* be interested in catching while the throws clause tells me
everything I *must* catch.

--
Bryan Thale
Networks & Infrastructure Research, Motorola Labs
mailto:bryan.thale at motorola.com






More information about the jdom-interest mailing list