java 注释及javac的注释标签写法规范

本文探讨了代码规范的重要性及如何使用Javadoc为代码添加注释。通过正确的注释方式,不仅能提高代码的可读性,还能便于团队成员之间的协作。

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

写这个日志的目的是为了规范化代码,因为我在项目维护中,发现之前同事留下的代码没有注释,而且不规范,看起来着实蛋疼,好像都是开始骂一遍,然后撸吧。

 

// 注释一行 
/* ...... */ 注释若干行 
/** ...... */ 注释若干行,并写入 javadoc 文档 

翻译后是没有注释的,可以用JD-GUI反编译,是没有注释的。

 

生成的文档是 HTML 格式,所以按照html语法写,

回车:<br>

分段: <p>

javadoc 标记有如下一些: 
@author 标明开发该类模块的作者 
@version 标明该类模块的版本 
@see 参考转向,也就是相关主题 
@param 对方法中某参数的说明 
@return 对方法返回值的说明 
@exception 对方法可能抛出的异常进行说明 

 

还有一些,可以参见java的源码书写方式。

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值