异常的抛出与文档的建立

最新推荐文章于 2022-12-26 08:35:40 发布
最新推荐文章于 2022-12-26 08:35:40 发布
阅读量138 收藏
点赞数
CC 4.0 BY-SA版权
文章标签： effective java
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.youkuaiyun.com/xujiajun945/article/details/84245299

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

在程序中异常的出现时不可避免的,对于异常而言,科学的管理方式是对异常进行文档说明,这样有利于后期方法正确的使用,对于接口而言,建立文档可以更好的让他人使用该接口

  • 始终要单独的声明受检查的异常,并且利用@throws进行标记
  • 不要声明一个最大的Exception或者Throwable,这样不利用后续对异常具体原因进行分析
  • 不要将运行时异常抛出,而是通过文档记录下有可能产生的所有运行时异常
  • 当一个类中多个方法因为同样的原因抛出了同样的异常,我们可以在类文档注释中对其进行说明

理想情况下是如此,可实际情况中,当代码后续修改后,可能会产生新的运行时异常

Java开发里JUnit的异常测试技巧
AI开发架构师
07-05 779
异常处理是Java编程中不可或缺的部分，而异常测试则是确保代码在异常情况下仍能按预期行为的关键手段。本文旨在为Java开发者提供一套完整的JUnit异常测试方法论，涵盖从基础到高级的各种技巧。文章首先介绍异常测试的基本概念，然后深入JUnit 4和JUnit 5的具体实现方式，接着探讨高级技巧和最佳实践，最后通过实际案例展示如何应用这些技巧。单元测试：对软件中最小可测试单元进行检查和验证异常测试：专门验证代码在异常情况下行为的测试测试覆盖率：衡量测试对源代码覆盖程度的指标断言(Assertion)
实现领域驱动设计（DDD）系列详解：异常处理
晓风残月淡的博客
06-10 1466
使用好异常的关键在于让它表达一定的领域含义，即细分模型不愿处理的条件，抛出有领域含义的异常，以便让合适的上级调用者找到合适的处理方式。显然，“购物车已满”的异常比“数组越界”的异常更容易让调用者知道如何处理。有些专家建议，当语言框架中已有相应异常时，不要自己创建异常，这适用于语言级别的异常。对于领域层来说，自定义异常是领域逻辑的一部分，它可以丰富通用语言。相比于错误代码，自定义异常能够很自然地被领域专家所理解。
第74项：每个方法抛出的所有异常都要建立文档
Coloured_Glaze的博客
09-07 265
  描述一个方法所抛出的异常，是正确使用这个方法时所需文档的重要组成部分。因此，花点实践仔细地为每个方法抛出的异常建立文档是特别重要的（第56项）。   始终要单独地声明受检的异常，并且利用Javadoc的@throws标记，准确地记录下抛出每个异常的条件 。如果一个方法可能抛出多个异常类，则不要使用“快捷方式（shortcut）”声明它会抛出这些异常类的某个超类。永远不要声明一个方法“throw...
Controller 层返回值的公共包装类-避免每次都包装一次返回-InitializingBean增强
热门推荐
hu10131013的博客
09-07 10万+
场景：在微服务中，一般返回数据都会有个返回码、返回信息和返回消息体，但是每次返回时候调用或者是封装，太过麻烦，有没有什么办法不用每次都封装呢？ 答案是有的。 返回值对象 package com.study.auth.comm; import com.alibaba.fastjson.JSON; import com.alibaba.fastjson.annotation.JSONField; import com.alibaba.fastjson.serializer.Serialize..
JNI官方规范中文版——如何在JNI中抛出Java异常
农场老马的专栏
10-14 2万+
很多情况下，本地代码做JNI调用后都要检查是否有错误发生，本章讲的就是怎么样检查错误和处理错误。 我重点放在JNI函数调用引发的错误上面。如果一个本地方法中调用了一个JNI函数，它必须遵守下面几个步骤来检查和处理这个JNI函数调用时可能引发的错误。至于其它可能的错误，比如本地代码中调用了一个可能引发错误的系统方法，那只需要按照该系统方法的标准文档中规定的来处理就可以了。 6.1 概述 我们通
EffectiveJava学习笔记29：异常（下）-方法抛出异常建立文档、异常注意事项
沙丁鱼的博客
12-26 166
1.方法抛出异常建立文档 为每个受检异常，尽量都利用javadoc的@throws标签单独声明，记录抛出每个异常的条件。 同时为方法可能抛出的未受检异常，通过@throws标签记录下来，不过不要放到方法的声明中。 如果一个类中有多个方法因为相同原因抛出同一异常，则在该类的文档注释中可以对这个异常建立文档 2.异常注意事项 1.捕获信息的处理：异常的细节信息应该是有关联的域的值...
throw throws Throwable 关联于区别
younkerjqb的专栏
08-20 8830
总结：throw 是在方法中抛出一个异常，不能单独使用 。 throws是在方法定义处或者类定义处声明该类或方法可能产生的异常，（一个或者多个）.----也可以理解为将方法内部异常不处理直接抛出，让调用处去处理。 throwable 是所有错误和异常的超类，所以当不知道要产生的异常是什么类型时候，直接throws Throwable即可
在 Python 中手动引发（抛出）异常
HuntsBot的博客
12-26 4101
如何在 Python 中引发异常，以便以后可以通过 except 块捕获它？
Python-错误和异常总结(内置异常、assert、抛出异常、异常捕获与处理)
关注网络安全、云原生安全
10-29 7230
简介 如果你编写过C++程序，相信你应该有过被“烫烫烫”、“屯屯屯”支配的恐惧。作为程序员，我们每天就是在写代码bug，然后改bug。通过本文你可以看懂自己程序发生的错误或异常，如何自己定义异常，如何处理/避免异常。你需要注意是什么引起了某个异常，在编程时进行避免或处理。 语法错误-SyntaxError 语法错误又称解析错误，语法错误导致不能被解释器解释或编译器无法编译，这些错误必须在程序执行前纠正。 >>> while True File "<stdin>",.
第六十二条 每个方法抛出的异常都要有文档
Deaht_Huimie的博客
11-14 374
每个方法，都要有文档注释，这样便于后期自己回顾当初的功能以及便于他人的阅读理解，同样的，每个方法抛出的异常，也需要文档注释。因此，花费时间为每个方法抛出的异常文档是特别重要的。我们要记住，需要声明受检的异常，用Javadoc的@throws标记，并记录每个异常的条件。如果一个方法会抛出多个异常类，不要直接声明可以抛出这些类的父类，也不要声明一个方法 “throws Exception”，或者直接声...
for循环中抛出异常_不要抛出循环！
cusi77914的博客
06-28 4411
到目前为止，在本系列文章中，我一直专注于Scala对Java生态系统的忠诚度，向您展示Scala如何整合Java的大部分核心对象功能。 但是，如果Scala只是编写对象的另一种方式，那么它就不会像它那样有趣或如此强大。 Scala的功能和对象概念的结合，以及对程序员效率的强调，使得学习这种语言比Java-cum-Scala程序员可能立即意识到的更为复杂和微妙。 关于本系列 Ted N...
mock 抛出一个异常如何终止_史上最全，一篇文章搞定Mock原理及应用
weixin_39559382的博客
11-22 3341
史上最全，一篇文章搞定Mock原理及应用目录一、Mock基础知识什么是MockMock的目的Mock的应用场景Mock框架对比(JAVA)二、Mockito研究主要资源环境起步核心注解常用方法三、MockMVC研究使用目的环境起步运行配置运行机制创建Builder方法解析四、...
JavaMail API完整类和异常详细文档
当发生与地址相关的问题时，AddressException异常类会被抛出，例如无效的邮件地址格式。 **AddressStringTerm** 该类用于表示邮件头部中的地址字符串。 **AddressTerm** AddressTerm用于匹配邮件头部地址字段的...
commons-net FTP功能实现与API帮助文档解读
commons-net提供的方法可能会抛出IOException，另外，FTP协议相关的异常，比如登录失败，文件不存在等也会被抛出。开发者需要根据实际情况进行相应的异常处理。 5. commons-net的帮助文档和API commons-net的帮助...
利用深度学习模型进行文本生成
08-13
资源下载链接为： https://pan.quark.cn/s/bfd5489ed3d3 利用深度学习模型进行文本生成（最新、最全版本！打开链接下载即可用！）
电力系统最优潮流分析：基于遗传算法的IEEE30节点输电网研究 完整版
08-13
内容概要：本文针对电力系统的最优潮流问题，采用遗传算法对IEEE30节点输电网进行优化分析。研究旨在通过调整发电机组出力，使系统发电成本最小化，从而提升电力系统的经济性和安全性。文中首先介绍了电力系统最优潮流的概念及其重要性，随后详细阐述了遗传算法的工作原理及其在电力系统中的优势。接着，作者构建了一个以系统发电成本为目标函数、机组出力为优化变量的数学模型，并引入了多种实际运行中的约束条件。通过遗传算法的选择、交叉和变异操作，不断优化解空间，最终获得了最佳机组出力方案。实验结果显示，相较于传统方法，遗传算法能更好地进行全局搜索，找到更优解，显著降低了系统发电成本。 适用人群：从事电力系统研究、设计和仿真的科研人员和技术人员，以及对遗传算法感兴趣的学者。 使用场景及目标：适用于需要优化电力系统运行效率的研究项目，特别是那些关注发电成本最小化的应用场景。目标是帮助研究人员理解和掌握遗传算法在电力系统最优潮流分析中的具体应用，为实际工程提供理论支持和技术指导。 其他说明：本文不仅提供了详细的理论推导和实验数据，还讨论了遗传算法在未来电力系统优化中的潜在发展方向。
基于西门子PLC-1200的伺服电机控制传送带设计方案及其工业应用 精华版
08-13
基于西门子PLC-1200的伺服电机控制传送带设计，涵盖了PLC技术概述、伺服电机的工作原理及其在传送带系统中的应用。文章从硬件和软件两个方面阐述了伺服电机控制传送带的具体实现方法，强调了高精度、高稳定性的设计要求。同时，还分析了这种设计在工业生产中的优势，如提高生产效率、保证产品质量一致性、提升自动化水平并降低成本。最后，提出了为确保设备长期稳定运行所需的维护和升级措施。 适合人群：从事工业自动化领域的工程师和技术人员，尤其是对PLC编程和伺服电机控制感兴趣的从业者。 使用场景及目标：适用于希望深入了解PLC与伺服电机集成应用的专业人士，旨在帮助他们掌握如何利用PLC实现高效的传送带控制系统，从而优化生产线管理。 其他说明：文中提供了丰富的技术细节和实践经验分享，对于想要进一步探索相关领域的读者来说是非常有价值的参考资料。
基于S7-200 PLC和组态王的六层电梯控制系统设计与实现
最新发布
08-13
基于西门子S7-200 PLC和组态王软件的六层电梯控制系统的设计与实现方法。主要内容涵盖梯形图程序解析、接线图原理图、IO分配以及组态画面设计等方面。文章首先阐述了IO分配的具体细节，如输入输出点的功能定义及其配置要点；接着深入探讨了梯形图编程的核心逻辑，特别是呼叫处理和方向判断算法；随后讲解了组态王画面设计的人机交互技巧，包括动画链接设置和轿厢移动仿真；最后分享了一些实用的调试经验和故障排除方法，如过冲保护措施和电气连接注意事项。 适合人群：从事自动化控制领域的工程师和技术人员，尤其是对PLC编程和HMI界面设计感兴趣的读者。 使用场景及目标：适用于需要理解和掌握小型电梯控制系统设计的专业人士，旨在帮助他们快速上手实际项目开发，提高系统稳定性和用户体验。 其他说明：文中提供了大量实例代码片段和具体参数设置建议，有助于读者更好地理解和应用相关知识点。同时强调了安全机制的重要性，如过冲保护和电气防护措施。
编程竞赛Cursor神操作编程创意赛实战攻略与案例解析：从创意构思到项目优化全流程指导
08-13
内容概要：本文档围绕“Cursor神操作编程创意赛”的参赛流程、项目创意构思方法、代码优化技巧及案例解析进行详细讲解，旨在帮助参赛者快速掌握Cursor编辑器的高效使用方法。文档首先介绍了比赛背景与目标，强调了比赛以“创意+高效编码”为核心，鼓励借助Cursor的AI辅助功能完成高质量项目。接着阐述了Cursor编辑器的优势，包括AI智能补全、代码重构与优化、跨语言支持等功能。然后分享了创意构思方法，如问题驱动法、技术融合法等。实战开发流程部分涵盖了需求分析、项目初始化、核心功能开发、界面优化、性能与安全优化五个阶段。最后提供了两个具体案例解析，分别是AI智能课堂助手和城市出行优化平台，并总结了比赛冲刺与展示技巧，指出参赛不仅能锻炼技术，还能积累项目经验和人脉资源。; 适合人群：学生、编程爱好者、全栈工程师及创客群体。; 使用场景及目标：①帮助参赛者快速掌握Cursor编辑器的高效使用方法；②通过创新的编程思路在比赛中脱颖而出；③为参赛者提供创意构思方法和实战开发指导。; 阅读建议：此资源详细讲解了参赛流程、创意构思、代码优化及案例解析，读者应结合自身情况，重点关注创意构思和实战开发流程，同时参考案例解析，以更好地理解和应用所学内容。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值