java注释

Posted 轮回守护

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了java注释相关的知识,希望对你有一定的参考价值。

什么是注释?

注释是出现在Java源代码里面,对源代码进行解释说明。就是在源代码里面用我们熟悉的语言(比如中文)来解释说明。注释的内容是不会出现在.class文件里面的,因此JVM是不会执行注释里面的内容的。

注释的作用

一般在开发的时候需要写大量的代码,这时程序的可读性就会低一些,那怎么办呢?我可以通过写一些注释,来解释一下某段代码的作用,可以让别人更快的明白一段代码的内容。所以在编写代码的时候尽量多写一些注释,这样别人在接手你的代码的时候会很快上手。

注释一共有三种:

  单行注释 : 使用  / / 来标注

  多行注释 : 使用  / * * / 来标注

  文档注释
  通常用于生成Java帮助文档,使用javadoc.exe命令可以将文档注释中内容生成帮助文档。什么是帮助文档?你可以将其理解为说明书。

      使用 / *** / 来标注,

  例如:

 

 


   

 

以上是关于java注释的主要内容,如果未能解决你的问题,请参考以下文章

真正的开发中,java代码要如何注释?

java代码注释(所有代码)注释比较重点的也行

Java代码注释

java 中的几种注释方式

Java基础复习2:程序注释标识符关键字

06 JAVA的注释