Java中的三种注释方法
Java包含三种注释方法,单行注释、多行注释和文档注释
单行注释
Java语言是采用 // 进行单行注释的,注释的方式是在需要注释的那一行代码之前打上 // ,注释掉的内容是包括从 // 起到这行结束。
我们来看一段代码,很简单,是个Hello的程序,输出两句话“您好,Tom猫”和“您好,Jerry鼠”如下图
然后我们我们将其中一行注释掉(这里选择Tom)
然后输出我们会发现只有“Hello,Jerry”了,因为“Hello,Tom”这一行代码被我们注释掉了,只是存在,但执行这个程序时不会执行这一行代码了
多行注释/* */
Java语言采用 /* */的方式进行多行注释,注释的方式是从需要注释的那一整段代码的第一行的代码之前打上前半部分,然后在需要注释的那一整段代码的最后一行代码之后打上后半部分 ,即可,注释掉的内容为/ **/中间的所有代码
初始化变量 a,使其等于0,然后一连做6个自加运算(a++ 意思是 a=a+1)运算结果是6
然后我们把中间4个 a++ 全部注释掉
运算结果就变成了2,因为只执行了2个 a++,其他4个用多行注释注释掉了没执行
文档注释
文档注释和多行注释有联系,也有区别。文档注释使用/** */的方式进行多行注释,但是,文档注释必须位于代码块的各个开头部分,比如需要放在public class 类 之前或者放在 main() 方法之前,如下图(缩进是为了程序更整洁);
在命令行执行 javadoc -d c:\help -author -version HelloWorld.java 指令,即可在C盘生成一个help文件夹,里面包含很多html,双击打开 index.html 后会在浏览器打开一个网页,网页中相应位置会有文档注释的内容,如下图(图中用黄色荧光笔涂上的部分,分别是该 html 的位置和文档注释的内容)
而多行注释则没有该功能,javadoc 工具软件还能识别很多标签,大家感兴趣可以自行探索。