Java学习笔记:(39)为所有导出的API元素编写文档注释

本文介绍了在编写代码时如何有效地添加注释,包括应该为哪些元素添加注释以及注释的具体内容,例如方法的调用前提、后续处理、副作用、参数说明、返回值描述和可能抛出的异常。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

需要增加注释的地方:类、接口、构造函数、方法和域声明,

方法注释的内容:

调用该方法的前提条件;
调用后的后续处理(如捕获异常);
副作用(如方法启动线程后带来的安全性);
参数@param Describe;
返回@return Describe;
异常@throws if.....;

注意:注释中可以适用<p><code><tt>等HTML标签,但>,<等标签需要转义。


评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值