Java中注释

我们在编写代码时,不仅仅是要让自己看懂,也要让他人看懂,所以在编写代码的过程时,我们要用注释来标注某行某段或某篇代码的作用是干什么的,这不仅是让他人看懂你的代码,同时也是方便自己后面对代码的查看和调用。

注释:

注释就是解释说明的文字

可分为 // 单行注释; /*多行注释*/ 和 /**文档注释*/ 三种。

作用:对程序的解释说明,便于后期的维护

原则:编写代码的过程中,要坚持注释先行的原则。

单行注释 //内容

作用域:单行有效

颜色:绿色

位置:行的上面 或者 行尾

嵌套:能嵌套单行,但不能嵌套多行或者文档

多行注释   /* 内容 */

作用域:多行内有效

颜色  :绿色

位置 : 类的上面或方法上面

嵌套 : 能嵌套单行不能嵌套多行|文档

 

文档注释  /**  内容   */

作用域 :多行内有效

颜色 : 蓝黑色

位置 : 类的上面或方法上面

嵌套 : 能嵌套单行不能嵌套多行|文档


            
多行与文档区别 

1.文档注释内容能够被保留 在api文档(说明手册)中但是多行与单行不能

2.如果在idea。。等编辑工具中,在方法上添加文档注释会自带声明说明,而多行注释没有            
            

 注意:

恰当位置添加注释

注释内容不会被编译

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值