博客
关于我
强烈建议你试试无所不能的chatGPT,快点击我
每个方法抛出的异常都要有文档(62)
阅读量:5737 次
发布时间:2019-06-18

本文共 262 字,大约阅读时间需要 1 分钟。

hot3.png

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

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

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

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

为每个未受检异常建立文档是理想状态,很多时候做不到

  • 如果没有为可抛出的异常建立文档,其他人很难使用你的类或接口

 

 

 

转载于:https://my.oschina.net/u/3847203/blog/2246052

你可能感兴趣的文章
centos文件目录权限常见的三个操作
查看>>
无人值守安装CentOS 7
查看>>
VMware vCenter 5.5 – You do not have permission to login to the server
查看>>
Blocked a frame with origin "null" from accessing a cross-origin frame.
查看>>
tap->S->mount to server->test 恢复测试
查看>>
CentOS 6.9 yum方式安装LAMP环境,并部署Discuz
查看>>
MySQL里的日期技巧
查看>>
linux初始化对/etc/rc.d/init.d的理解
查看>>
java基础数据类型char
查看>>
Android Day11 - 动画
查看>>
Gitlab的介绍及使用
查看>>
冒泡排序
查看>>
Python-OpenCV基本操作
查看>>
jquery获取url参数值
查看>>
高阶函数
查看>>
ORACLE or Oracle?
查看>>
linux的增删改查、压缩与解压缩
查看>>
将一文件某一列乘以2
查看>>
链路聚合测试
查看>>
oracle安装用户环境变量配置
查看>>