Java的注释

编写程序时总需要为程序添加一些注释,用以说明某段代码的作用,或者说明某个类的用途、某个方法的功能,以及该方法的参数和返回值的数据类型及意义等。
为什么要添加注释:
(1)永远不要过于相信自己的理解力!一段时间过后,你很难再重进进入当初编写程序时的思维。
(2)可读性第一,效率第二!越来越多的人加入了软件队伍,并引用了工程化的方式来管理软件开发。这个时候,软件开发变成了团队的协同作战,因此一个人写的代码要便于其他人能够快速理解。
(3)代码即文档,代码是程序文档的重要组成部分,程序文档规范要求代码书写规范。

注释:单行注释  // 注释内容
     多行注释  /* 注释内容 */
     文档注释  /** 注释内容 */  
Java 提供的Javadoc工具可以将文档注释抽离出来生成一份系统的API文档,方便开发者查看。注意:Javadoc默认只能提取出public和protected修饰的变量或方法。如果希望提取出private修饰的方法或变量,则需要在Javadoc增加-private选项。
  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值