使用JavaDoc工具，生成源码文档

/*
 * generate doc: javadoc.exe des_path -author -version src.java
 * */

public class TestDoc {

	/**
	 * @param args
	 */
	public static void main(String[] args) {
		// TODO Auto-generated method stub

	}
	
	/**
	 * This is first line.<br>
	 ********This is second line.<br>
	 This is third line.
	 */
	private static void testPrivateMethod() {
		// TODO Auto-generated method stub

	}
	
}
/** comment for class */
class Test{
	/** comment for a attribute */
	int number;
	
	/** comment for a method */
	public void myMethod(){
		
	}
	
	/**
	 * show 方法的简述.
	 * <p>show 方法的详细说明第一行<br>
	 * show 方法的详细说明第二行
	 * @param b true 表示显示，false表示隐藏
	 * @return Test 返回一个Test型的变量
	 */
	public Test show(boolean b){
		myMethod();
		return new Test();
	}
}

/**
 * javadoc 标记
 * 
 * 标记			用于					作用
 * @author		对类的说明			标记开发该类模块的作者
 * @version		对类的说明			标记譔类模块的版本
 * @see			对类、属性、方法的说明	相关主题引用
 * @param		对方法的说明			对方法中某参数的说明	
 * @return		对方法的说明			对方法返回值的说明
 * @exception	对方法的说明			对方法可能抛出的异常进行说明
 * 
 * 1.@see的使用句法：
 * @see 类名
 * @see #方法名或属性名
 * @see 类名#方法名或属性名
 * 
 * A。根据需要：类名可可以直接写类名（如String）或 全名（java.lang.String）
 * 可以只写类名的情况是：文件已引入该类包   或 使用javac 能找到类名。
 * 
 * B。如果是属性名，只需要写出属性名即可；如果是方法名，则需写出方法名及参数类型。
 * 没有参数的，要写一对括号。
 */
/**
 * @see String
 * @see java.lang.StringBuffer
 * @see #str
 * @see #str()
 * @see #main(String[])
 * @see Object#toString()
 */
class TestJavaSee{
	String str;	
	void str(){}
	void main(String[] a){}	
}
/**其中类中只有本类中的方法及属性的链接，因为编译时类String, StringBuffer, Object
 * 并没有参与编译，所以没有其类信息的链接*/

/**
 * @author yuanlong
 * @author linglong
 * @version Version 1.0.1
 * @version Version 2.0.1 
 */
class TestJavaAuthorAndVersion{
}


/**
 * @author yuanlong<br>linglong
 * @version Version 1.0.1<br>Version 2.0.1 
 */
class TestJavaAuthorAndVersion2{
}

/**
 * @param\ @return\ @exception 说明方法
 */

class TestJavaParamReturnException{
	/**
	 * @param n a switch
	 * @param b excreascent parameter
	 * @return true or false
	 * @return excereascent return
	 * @exception java.lang.Exception throw when switch is 1
	 * @exception NullPointerException throw when parameter n
	 */
	public boolean fun(Integer n) throws Exception{
		switch (n.intValue()){
		case 0:
			break;
		case 1:
			throw new Exception("Test Only");
		default:
			return false;
		}
		return true;
	}
}

生成的文档：

1.

类 TestDoc

• java.lang.Object
• • TestDoc

• ---

  
  

  public class TestDoc
  extends java.lang.Object

• • 构造器概要

    构造器  

    构造器和说明
    TestDoc()

  • 方法概要

    方法  

    限定符和类型	方法和说明
    static void	main(java.lang.String[] args)
    private static void	testPrivateMethod() This is first line.

    • 从类继承的方法 java.lang.Object

      clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

• • 构造器详细资料

    • TestDoc

      public TestDoc()

  • 方法详细资料

    • main

      public static void main(java.lang.String[] args)

      参数:

      args -

    • testPrivateMethod

      private static void testPrivateMethod()

      This is first line.
      This is second line.
      This is third line.

2.

类 Test

• java.lang.Object
• • Test

• ---

  
  

   class Test
  extends java.lang.Object

  comment for class

• • 字段概要

    字段  

    限定符和类型	字段和说明
    (专用程序包) int	number comment for a attribute

  • 构造器概要

    构造器  

    构造器和说明
    Test()

  • 方法概要

    方法  

    限定符和类型	方法和说明
    void	myMethod() comment for a method
    Test	show(boolean b) show 方法的简述.

    • 从类继承的方法 java.lang.Object

      clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

• • 字段详细资料

    • number

      int number

      comment for a attribute

  • 构造器详细资料

    • Test

      Test()

  • 方法详细资料

    • myMethod

      public void myMethod()

      comment for a method

    • show

      public Test show(boolean b)

      show 方法的简述.

      show 方法的详细说明第一行
      show 方法的详细说明第二行

      参数:

      b - true 表示显示，false表示隐藏

      返回:

      Test 返回一个Test型的变量

3.

类 TestJavaSee

• java.lang.Object
• • TestJavaSee

• ---

  
  

   class TestJavaSee
  extends java.lang.Object

  另请参阅:

  String,  StringBuffer,  str,  str(),  main(String[]),  Object.toString()

• • 字段概要

    字段  

    限定符和类型	字段和说明
    (专用程序包) java.lang.String	str

  • 构造器概要

    构造器  

    构造器和说明
    TestJavaSee()

  • 方法概要

    方法  

    限定符和类型	方法和说明
    (专用程序包) void	main(java.lang.String[] a)
    (专用程序包) void	str()

    • 从类继承的方法 java.lang.Object

      clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

• • 字段详细资料

    • str

      java.lang.String str

  • 构造器详细资料

    • TestJavaSee

      TestJavaSee()

  • 方法详细资料

    • str

      void str()

    • main

      void main(java.lang.String[] a)

4.

类 TestJavaAuthorAndVersion

• java.lang.Object
• • TestJavaAuthorAndVersion

• ---

  
  

   class TestJavaAuthorAndVersion
  extends java.lang.Object

  版本:

  Version 1.0.1, Version 2.0.1

  作者:

  yuanlong, linglong

• • 构造器概要

    构造器  

    构造器和说明
    TestJavaAuthorAndVersion()

  • 方法概要

    • 从类继承的方法 java.lang.Object

      clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

• • 构造器详细资料

    • TestJavaAuthorAndVersion

      TestJavaAuthorAndVersion()

5.

类 TestJavaAuthorAndVersion2

• java.lang.Object
• • TestJavaAuthorAndVersion2

• ---

  
  

   class TestJavaAuthorAndVersion2
  extends java.lang.Object

  版本:

  Version 1.0.1
  Version 2.0.1

  作者:

  yuanlong
  linglong

• • 构造器概要

    构造器  

    构造器和说明
    TestJavaAuthorAndVersion2()

  • 方法概要

    • 从类继承的方法 java.lang.Object

      clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

• • 构造器详细资料

    • TestJavaAuthorAndVersion2

      TestJavaAuthorAndVersion2()

6.

类 TestJavaParamReturnException

• java.lang.Object
• • TestJavaParamReturnException

• ---

  
  

   class TestJavaParamReturnException
  extends java.lang.Object

• • 构造器概要

    构造器  

    构造器和说明
    TestJavaParamReturnException()

  • 方法概要

    方法  

    限定符和类型	方法和说明
    boolean	fun(java.lang.Integer n)

    • 从类继承的方法 java.lang.Object

      clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

• • 构造器详细资料

    • TestJavaParamReturnException

      TestJavaParamReturnException()

  • 方法详细资料

    • fun

      public boolean fun(java.lang.Integer n)
                  throws java.lang.Exception

      参数:

      n - a switch

      b - excreascent parameter

      返回:

      true or false

      抛出:

      java.lang.Exception - throw when switch is 1

      java.lang.NullPointerException - throw when parameter n