第六十二条:每个方法抛出的异常都要有文档
2015-06-02 14:41
218 查看
花点时间仔细为每个方法抛出的异常建立文档是特别重要的。
始终要单独的声明受检的异常,并且利用Javadoc的@throws标记,准确的记录下抛出每个异常的条件。
如果一个方法可能抛出多个受检异常,则不要使用“快捷方式”声明这个方法会抛出这些异常类的超类,如永远不要声明一个方法“throws Exception”,
或者更糟糕的是声明这个方法“throws Throwable”。因为这样的声明不仅没有为程序员提供关于“这个方法能够抛出哪些受检异常”的任何知道信息,
而且还大大妨碍了该方法的使用,因为它实际上掩盖了该方法在同样的执行环境上可能抛出的任何其他异常。
虽然Java语言并不要求程序员在一个方法的声明中写出它可能会抛出的未受检异常,但是,如同受检异常一样,仔细的为未受检异常建立文档是非常明智的。
未受检的异常通常代表编程上的错误,是不可恢复的,让程序员了解所有这些错误都有助于帮助他们避免犯这样的错误。使用Javadoc的@throws标签记录
一个方法可能抛出的每个未受检异常,但是不要使用throws关键字将未受检异常包含在方法的声明中。这样,程序员在使用这个方法时结合Javadoc的@throws
和方法声明的throws后面的异常,可以明确的知道这个方法抛出的异常哪些是受检的异常,哪些是未受检的异常。
始终要单独的声明受检的异常,并且利用Javadoc的@throws标记,准确的记录下抛出每个异常的条件。
如果一个方法可能抛出多个受检异常,则不要使用“快捷方式”声明这个方法会抛出这些异常类的超类,如永远不要声明一个方法“throws Exception”,
或者更糟糕的是声明这个方法“throws Throwable”。因为这样的声明不仅没有为程序员提供关于“这个方法能够抛出哪些受检异常”的任何知道信息,
而且还大大妨碍了该方法的使用,因为它实际上掩盖了该方法在同样的执行环境上可能抛出的任何其他异常。
虽然Java语言并不要求程序员在一个方法的声明中写出它可能会抛出的未受检异常,但是,如同受检异常一样,仔细的为未受检异常建立文档是非常明智的。
未受检的异常通常代表编程上的错误,是不可恢复的,让程序员了解所有这些错误都有助于帮助他们避免犯这样的错误。使用Javadoc的@throws标签记录
一个方法可能抛出的每个未受检异常,但是不要使用throws关键字将未受检异常包含在方法的声明中。这样,程序员在使用这个方法时结合Javadoc的@throws
和方法声明的throws后面的异常,可以明确的知道这个方法抛出的异常哪些是受检的异常,哪些是未受检的异常。
相关文章推荐
- SpringMVC3的中文乱码问题
- 【PAT 乙级(Basic Level)】福尔摩斯的约会
- oracle11g密码过期问题
- oracle数据库基本操作
- 使用junit测试SpringMVC
- linux挂载ipsan服务器
- 无需客户端PLSQL连接Oracle的方法
- 关于分布式程序 java的内存管理浅谈
- 泛型类的自定义
- 泛型类的自定义
- 编写一个字符驱动
- shell条件判断式语句
- ESXI5.5设置主机的时间自动同步服务 NTP
- OC笔记,字符串NSString
- LRU Cache分析
- 记Flume-NG一些注意事项(不定时更新,欢迎提供信息)
- Android进步之路五:startActivityForResult详解
- 工作周报043
- C++/C# 托管扩展 更改概要 [转]
- HDU2255——KM算法——奔小康赚大钱