Java养成写注释的习惯

注释

1. 三种注释方法

1.1 //

• 一般用于方法的内部，起到解释的作用，有点像批注。
• 是为了给自己看的
• 有些逻辑，比较难，打上这个注释，把逻辑标明等。

1.2 /* */

• 段落注释
• 也是给自己看的
• 它能写的内容更多一些
• 其余的与 // 差不多。

1.3 /** */

• 重点
• 这个是说明文档
• 按照标准，每个方法，类，接口，异常等。都要使用这个。
• 如：

/**
 * 
 */
public class Test {
	
	/**
	 * 
	 */
	public Test() {
	}
	
}

2. 使用javadoc

2.1 为什么要用？

• 使用了 /** */
• 就可以用javadoc，生成说明文档。

2.2 怎样使用

2.2.1 在eclipse中

1. 打开文件资源管理器。

2. 右键你要导出说明文档的类。

3. 点击导出。
   

4. 在弹出的页面中，点击Java。

5. 在选项中，选择Javadoc。
   

6. 在目标中，选择导出文件的位置。

7. 点击完成，就行了。

2.2.2 在DOS命令中

1. 保证javadoc命令正常安装。
2. 命令：javadoc xxx.java
3. 未安装javadoc的在我的java配置环境中去看一下。