友情博客

  2007-3-26

方法抛出的所有异常都可以用 javadoc 的 @throws 来注释（同 @exception 一样）。一些人主张每一个抛出的异常都应该写在 @throws 里，因为这是让调用者明确必要条件的唯一方法（前至条件）。然而，其他的却不同。

如果所有的 null 对象传到方法的时候都能引起 NullPointerException 异常的话，那么可以接受的声明办法就是在类的 classdoc 中声明一次，而不是为每一个方法都声明。另外一种方法是在 overview.html 声明，这样所有的参数都被默认为非空除了明确的声明。

例如：

这个例子大量的运用了不是很常见的前至条件。注意 NullPointerException 被放在了类一级的 javadoc 声明中。

注意未被检测的 SecurityException 通过调用 File 类间接的被抛出。

import java.io.*;

/**
* If a null object parameter is passed to any method, then a
* <code>NullPointerException</code> will be thrown.
*/
public class WriteTextFil