每个方法抛出的异常都要有文档

规范API文档与异常处理
本文强调了良好的代码文档尤其是API文档的重要性,并着重说明如何通过使用Javadoc的@throws标记来详细记录接口方法可能抛出的异常。文章指出正确记录异常可以帮助开发者避免编程错误。

我们应该做好代码的文档,特别是API的文档。对于异常更是如此。
经典:总是要单独的声明被检查的异常,并且利用Javadoc的@throws标记,准确的记录下每个异常被抛出的条件。

前面我们就说了未被检查的异常代表了编程上的错误,可以让程序员熟悉这些错误有助于让他们避免错误。

对于接口的方法,我们也应该去记录该方法抛出的异常。因为接口是通用的约定。

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值