java 中的几种注释方式

我看动力节点的java基础大全301集教中的三种注释方法：

1、单行注释   //注释的内容

2、多行注释  /*......*/

3、/**......*/，这种方式和第二种方式相似。这种格式是为了便于javadoc程序自动生成文档。

下面介绍拍模一下Javadoc的标记：

特别声明：  

（1）javadoc针对public类生成注释文档

（2）javadoc只能在public、protected修饰的方法或者属性之上

（3）javadoc注释的格式化：前导*号和HTML标签

（4）javadoc注释要仅靠在类、属性、方法之前

下面主要举例说明第三种注袭丛缓释的应用：

（1）首先编写.java文件

（2）在命令行中执行以下dos命令：            

javadoc *.java //根据相应的Java源代码及其说明语句生成郑宽HTML文档

//javadoc标记：是@开头的，对javadoc而言，特殊的标记。

（3）在当前目录下就会产生doc文件夹，里面有一系列的.html文件

附上代码：

[java] view plain copy

• */  

• /**javadoc注释的内容 

• */  

• public class Hello{  

• /**属性上的注释*/  

• public String name;  

• /**这是main方法,是程序的入口 

• *@param args 用户输入参数 

• */  

• public static void main(String[] args){  

• System.out.println("Hello World!");  

• f1();  

• }  

• /** 这是第1个方法,其作用是...*/  

• public static void f1(){  

• System.out.println("f1()！");  

• }  

• }  

[java] view plain copy

• import java.io.IOException;  

• /**javadoc注释内容 

• *@since 1.0 

• *@version 1.1 

• *@author Blue Jey 

• *
  链接到另一个文档{@link Hello},就这些 

• *see Hello 

• */  

• public class HelloWorld{  

• /**非public，protected 属性上的注释不生成*/  

• public String name;  

• /**这是main方法，是程序的入口 

• *@param args 用户输入的参数，是数组 

• *@throws IOException main方法io异常 

• */  

• public static void main(String args[]) throws IOException{  

• System.out.println("hello World!");  

• f1();  

• f2(1);  

• }  

• /**这是第一个方法，其作用是.... 

• *@deprecated 从版本1.2开始，不再建议使用此方法 

• */  

• public static void f1(){  

• System.out.println("fl()!");  

• }  

• /**这是第二个方法，其作用是.... 

• *@return 返回是否OK 

• *@param i 输入参数i 

• *@see Hello 

• *@throws IOException io异常 

• */  

• public static String f2(int i)throws IOException{  

• System.out.println("f1()!");  

• return "OK";  

• }  

• }   

注意：

如果源文件中有用到@version,@author标记，则在执行javadoc命令时，要加-version -author 

javadoc -version -author -d doc *.java

（其中用-version用于提取源文件中的版本信息 -author用于提取源文件中的作者信息）

三种类型：
1、单选注释：符号是：//
2、块注释： 符号是：携答饥 /* */辩返 可以跨多行
3、javadoc注释： 符号是举衫： /** */ 可以跨多行，
生成javadoc时，这样的注释会被生成标准的javaapi注释。

1、单选：//
2、亮孙多行： /* */
3、javadoc注释： /** */ （一般用于敬哗链某方法或类芦春前面，其它地方调用时，放鼠标上面会看到注释内容）

// 单行注释
/*
*
*/ 多行和文本注释