JAVA DOC 标记

原帖地址：

http://blog.csdn.net/crazy_for_net/article/details/49981175

三种注释方法：

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

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

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

       下面介绍一下Javadoc的标记：

    

JavaDoc 标 记	解释
@version	指定版本信息
@since	指定最早出现在哪个版本
@author	指定作者
@see	生成参考其他的JavaDoc文档的连接
@link	生成参考其他的JavaDoc文档，它和@see标记的区别在于，@link标记能够嵌入到注释语句中，为注释语句中的特殊词汇生成连接。  eg.{@linkHello}
@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文件

附上代码：

  

[java]  view plain  copy

1. <span style="font-size:18px;">*/  
2. /**javadoc注释的内容 
3. */  
4. public class Hello{  
5.     /**属性上的注释*/  
6.     public String name;  
7.     /**这是main方法,是程序的入口 
8.     *@param args 用户输入参数 
9.     */  
10.     public static void main(String[] args){  
11.     System.out.println("Hello World!");  
12.         f1();  
13.     }  
14.     /** 这是第1个方法,其作用是...*/  
15.     public static void f1(){  
16.       System.out.println("f1()！");  
17.     }  
18. }</span>  

 

[java]  view plain  copy

1. <span style="font-size:18px;">import java.io.IOException;  
2. /**javadoc注释内容 
3. *@since 1.0 
4. *@version 1.1 
5. *@author Blue Jey 
6. *<br>链接到另一个文档{@link Hello},就这些 
7. *see Hello 
8. */  
9. public class HelloWorld{  
10.     /**非public，protected 属性上的注释不生成*/  
11.     public String name;  
12.     /**这是main方法，是程序的入口 
13.     *@param args 用户输入的参数，是数组 
14.     *@throws IOException main方法io异常 
15.     */  
16.     public static void main(String args[]) throws IOException{  
17.         System.out.println("hello World!");  
18.           
19.         f1();  
20.         f2(1);  
21.         }  
22.     /**这是第一个方法，其作用是.... 
23.     *@deprecated 从版本1.2开始，不再建议使用此方法 
24.     */  
25.     public static void f1(){  
26.         System.out.println("fl()!");  
27.         }  
28.     /**这是第二个方法，其作用是.... 
29.     *@return 返回是否OK 
30.     *@param i 输入参数i 
31.     *@see Hello 
32.     *@throws IOException io异常 
33.     */  
34.     public static String f2(int i)throws IOException{  
35.         System.out.println("f1()!");  
36.         return "OK";  
37.         }  
38.     } </span>  

  注意：

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

   javadoc -version -author -d doc *.java

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