每一个方法抛出的异常都要有文档(62)

描述一个方法所抛出异常,是这个方法(javadoc文档)所需文档重要组成部分java

  • 花时间为每一个抛出的异常创建文档很重要

始终单独声明每一个受检的异常接口

  • JavaDoc 中使用 @throws标记,准确的记录抛出每一个异常的条件
  • 不要懒省事抛出异常的超类,尤为不要声明 抛出 Exception 类 Throwable 接口

为每一个未受检异常创建文档是理想状态,不少时候作不到文档

  • 若是没有为可抛出的异常创建文档,其余人很难使用你的类或接口
相关文章
相关标签/搜索