Java注释

注释

• 为程序添加注释可以用来解释程序的某些语句的作用和功能，提高程序的可读性。也可以使用注释在原程序中插入设计者的个人信息。此外，还可以用程序注释来暂时屏蔽某些程序语句，让编译器暂时不要处理这部分语句，等到需要处理的时候，只需把注释标记取消就可以了。JAVA中的注释有三种：

单行注释

• 单行注释就是在程序中注释一行代码。在Java语言中，将双斜线（//）放在需要注释的内容之前就可以了，Java编译器会忽略掉这部分信息。

多行注释

• 多行注释是指一次性地将程序中多行代码注释掉。在Java语言中，使用“/*”和“*/”将程序中需要注释的内容包含起来，“/*”表示注释开始，而“*/”表示注释结束。当注释内容超过一行时一般使用这种方法。
• 下面代码中增加了单行注释和多行注释。

public class CommentTest {
	/*
	 * 这里面的内容全部是注释文字
	 * Java语言的学习是非常有趣的
	 * 让我们一起去发现它的奥妙吧
	 */
	public static void main(String[] args) {
		//这是一个单行注释
		System.out.println("Hello, 2018！");
		//System.out.println("这行代码被注释了，将不会被编译、执行");
	}
}

文档注释

• Java语言还提供了一种功能更强大的注释形式：文档注释。如果编写Java源代码时添加了合适的文档注释，然后通过JDK提供的javadoc工具可以直接将源代码里的文档注释提取成一份系统的API文档。*(提问:什么是API文档？计1于娇35)
• 在Java语言中，使用“/**”和“*/”将程序中需要注释的内容包含起来，“/**”表示文档注释开始，而“*/”表示注释结束。
• 实例： 下面是一个使用说明注释的简单实例。注意每一个注释都在它描述的项目的前面。

/** 我的测试类
*<br>这是一个测试类。
*<br>创建时间 2018-03-10
*@author 马欣
*@version V1.0
*/
public class Test
{

    
    /**
    *这是该类的main方法
    *
    */
    public static void main(String[] args)
    {
    }
}

• 从Eclipse中导出注释：

 在项目列表中按右键，选择Export（导出），然后在Export(导出)对话框中选择java下的javadoc，提交到下一步。 
在Javadoc Generation对话框中有两个地方要注意的： 
javadoc command:应该选择jdk的bin/javadoc.exe 
destination:为生成文档的保存路径，可自由选择。 
按finish(完成)提交即可开始生成文档。 

返回 Java程序设计