Java的三种注释 Javadoc标记*

三种注释方法：

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

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

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

       下面介绍一下Javadoc的标记：

    

JavaDoc 标 记	解释
@version	指定版本信息
@since	指定最早出现在哪个版本
@author	指定作者
@see	生成参考其他的JavaDoc文档的连接
@link	生成参考其他的JavaDoc文档，它和@see标记的区别在于，@link标记能够嵌入到注释语句中，为注释语句中的特殊词汇生成连接。  eg.{@link Hello}
@deprecated	用来注明被注释的类、变量或方法已经不提倡使用，在将来的版本中有可能被废弃
@param	描述方法的参数
@return	描述方法的返回值
@throws	描述方法抛出的异常，指明抛出异常的条件

特别声明：  

    （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文件

附上代码：

  

*/
/**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()！");
    }
}

 

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用于提取源文件中的作者信息）