Java基础学习总结(36)——Java注释模板

本文总结了Java代码注释的原则、条件、格式,并介绍了javadoc注释标签的使用,提供了一套完整的代码注释模板,包括类、构造方法、方法、全局变量等,并给出了代码修改注释的标准格式,旨在提升团队开发效率和代码可维护性。
摘要由CSDN通过智能技术生成

代码注释是对代码设计者、代码阅读者以及系统间调用提供了有效的帮助,最大限度的提高团队开发合作效率增强系统的可维护性。我们追求简化,不是为了写注释而写注释。

(快速使用请直接看六、七、八)

一、原则:

1.注释形式统一

使用统一的注释风格,不要随意创建新的注释风格。

2.注释准确简洁

内容要简单、明了,防止注释的多义性,错误的注释不但无益反而有害。

二、注释条件:

1.基本注释(必须加)

a)类(接口)的注释

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

一杯甜酒

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值