JavaSE基础——基础语法3：包机制与JavaDoc

JavaSE基础——基础语法3：包机制与JavaDoc

五、包机制、JavaDoc

1.包机制

为更好地组织类，Java提供了包机制，用于区别类名的命名空间。

一般以公司域名的倒置作为包名。

为了能够使用某一包内的成员，需要在Java程序里明确导入该包，使用import语句实现此功能。

package com.Study.SHILIKNG.www; //package关键字指明当前类所在的包名，包就相当于文件夹
import javax.xml.crypto.Data;   //为了能够使用某一包内的成员，需要在Java程序里明确导入该包，使用import语句实现此功能
//import com.SHILIKNG.www.Demo01    导入com.SHILIKNG.www包内的类Demo01，与当前的类Demo01冲突，因此类名应该命名为不同的名称
//import com.SHILIKNG.www.*         *是通配符，该语句表示导入com.SHILIKNG.www包内的所有类
public class Demo01 {
    public static void main(String[] args) {
        Data   //这里的Data是javax.xml.crypto下的成员
    }

2.文档注释及JavaDoc

package com.Study.SHILIKNG.www;
import java.io.*;   // 导入java.io包内所有的类
/**
 * 这个类进行文档注释的演示
 * @author  SHILIKNG
 * @version test1.0
 * @since 1.8
 */
public class Demo02 {
    /**该方法返回数字的平方
     * @param num The value to be squared.
     * @return num squared.
     */
    public double square (double num) {
        return num * num;
    }
    /**
     * 该方法用于接收一个从用户那里输入的数
     * @return The value input as a double.
     * @exception IOException On input error.
     * @see IOException
     */
    public double getNumber() throws IOException {
        InputStreamReader isr = new InputStreamReader(System.in);
        BufferedReader inData = new BufferedReader(isr);
        String str;
        str = inData.readLine();
        return (new Double (str)).doubleValue();
    }
    /**
     * main方法，调用上述平方计算和接受数值方法，显示所接受数的平方计算后的结果
     * @param args Unused.
     * @exception  IOException on input error.
     * @see IOException
     */
    public static void main(String[] args) throws IOException {
        Demo02 ob = new Demo02();
        double val;
        System.out.println("Enter value to be aquared: ");
        val = ob.getNumber();
        val = ob.square(val);
        System.out.println("Squared value is " + val);
    }
}
-----------------------------
运行结果：
    Enter value to be aquared: 
    2
    Squared value is 4.0
下面利用IDEA对程序中缩写的文档注释生成JavaDoc文档：

1. 选择菜单Tools->Generate JavaDoc

   

2. 进行JavaDoc文档生成设置

   文档信息栏中填写：-encoding UTF-8 -charset UTF-8 -windowtitle "test"

   其中：-encoding是java代码编码，设定为UTF-8编码. -charset是对生成文档所用的编码,设定为UTF-8编码.-windowtitle就是对应html的<title>标签

   

3. 结果：

   

3.文档注释中的标签

标签	描述	示例
@author	标识一个类的作者	@author description
@deprecated	指名一个过期的类或成员	@deprecated description
{@docRoot}	指明当前文档根目录的路径	Directory Path
@exception	标志一个类抛出的异常	@exception exception-name explanation
{@inheritDoc}	从直接父类继承的注释	Inherits a comment from the immediate surperclass.
{@link}	插入一个到另一个主题的链接	{@link name text}
{@linkplain}	插入一个到另一个主题的链接，但是该链接显示纯文本字体	Inserts an in-line link to another topic.
@param	说明一个方法的参数	@param parameter-name explanation
@return	说明返回值类型	@return explanation
@see	指定一个到另一个主题的链接	@see anchor
@serial	说明一个序列化属性	@serial description
@serialData	说明通过writeObject( ) 和 writeExternal( )方法写的数据	@serialData description
@serialField	说明一个ObjectStreamField组件	@serialField name type description
@since	标记当引入一个特定的变化时	@since release
@throws	和 @exception标签一样.	The @throws tag has the same meaning as the @exception tag.
{@value}	显示常量的值，该常量必须是static属性。	Displays the value of a constant, which must be a static field.
@version	指定类的版本	@version info

转载