Java注释详解一二三

Java注释详解

编写程序时总需要为程序添加一些注释，用以说明某段代码的作用，或者说明某个类的用途、某个方法的功能，以及该方法的参数和返回值的数据类型及意义等

1 为啥一定要写注释

• 方便自己查看：自己写的代码，可能过一段时间后自己都变得不熟悉。这个时候，注释就起到了很好的帮助作用

• 可读性第一，效率第二：一个开发团队一般都是协同作战。因此，一个人写的代码，需要被整个团队的其他人所理解

• 代码即文档：程序源代码是程序文档的重要组成部分

2 注释的语法规则

在 Java 中，有三种书写注释的方式

• 单行注释
• 多行注释
• 文档注释（Java特有）

2.1 单行注释

单行注释：最常用的注释方式，其注释内容从 "//"开始到本行末尾

// 作者：jia.
// 日期：08/04.

public class HelloWorld{
// 类名：HelloWorld.
// 作用：一个简单Java应用程序.
	public static void main(String[] args){
		// main方法，Java应用程序的入口
		System.out.println("Hello World!");
        // 向控制台输出语句 HelloWorld!
        // System.out.println("Hello China!");
        // 上面这句代码被注释掉了，不会执行！
	}
}
// HelloWorld类的所有成分都应该定义在HelloWorld类的一对大括号"{}"内.

2.2 多行注释

多行注释：注释内容放到 /*和*/之间。即，注释从 /* 开始，到 */ 结束

/* 作用：jia. */
/* 日期：08/04. */
 
public class HelloWorld{
    /* 类名：HelloWorld.
       作用：一个简单的 Java 应用程序. */
	public static void main(String[] args){
	/* 可以注释一行内容 */
	/* main 方法，Java 应用程序的入口 */	
		System.out.println("HelloWorld!");
		/* 也可以注释多行内容 */
		/*System.out.println("不知道说什么了，举什么例子好呢？");
          System.out.println("Hello China!");*/
	}
}

注意：

• 单行注释和多行注释，注释了的内容不参与编译，换句话说，编译之后的.class结尾的字节码文件中不包含注释掉的信息
• 多行注释不可以嵌套使用

2.3 文档注释

文档注释：Java 语言提供了专门用于生成文档的注释；文档注释是以/** 开始，以 */结束的

/**
 * This is a simple class.
 * @author louis
 * @version 1.0
 */
public class HelloWorld{
    /**
	 * main function,the entrance of Java Application.
	 * @param args command line arguments.
	 */
	public static void main(String[] args){
		System.out.println("Hello World!");
	}
}

打开命令提示符我们简要了解一下javadoc命令：

下面使用 JDK 中的javadoc命令，来生成 Java 的 API 文档，在命令提示行中输入javadoc -d myhello HelloWorld.java

因为javadoc输出的内容不止一项，所以新建一个文件夹myhello会比较整齐方便

我们用浏览器打开这个名为index.html文件

以上就是Java注释的内容，大家可以自己尝试！

3 优秀的文档注释介绍文章

篇①
篇②

---

4 资料分享^-^

给大家分享一份我发现的学习资料，很不错，如有需要可以领一下哟！