Java中的包和文档

副标题#e#

什么是包

Java中的包（Package）其实指的就是目次，它是为了更好地打点Java类（Class）和接口（Interface）。Java语言的包可以被另一个Java开拓包所利用。假如我们要引用某个包中的类，用import要害字来标明即可。好比：

import java.util. date=new Date

提示：import java.util.暗示java.util中的所有公有类和接口被引入到当前包。这里的匹配符可以调入多个类名。

常用的Java尺度包

JDK为我们提供了许多尺度的Java类和接口，这些包是写Java措施所必须的，知道了每种包所包括的类和接口，而且熟悉这些类和接口是每个Java编程人员都应该把握的根基技术。

Java中常用的包有：Java.applet、java.awt、java.i、java.lang、java.net和java.util等等。个中java.applet包括了一些设计小应用措施（Applet）的类和接口；java.awt是一个窗口东西箱包（awt Abstract Window Toolkit），内里是一些GUI界面相关的类；java.io包支持输入输出，好比文件输入流类：FileInputStream等；java.lang包括线程、异常、系统、整数等相关的类，是Java措施中默认加载的一个包；java.net这个类支持TCP/IP网络协议，并包括Socket类及URL相关的类，是网络编程中要利用的；java.util包括一些措施的公用类，如Date烡ictionary等等。

除了上面提到的一些尺度包之外，尚有许多其它的包，好比数据库编程时我们大概需要利用java.sql包，写网络措施还会用到java.rmi包（RMI Remote Method Invocation）等。别的，Javax.澃是一些尺度包的扩展，常用的包有：javax.swing、javax.sound。

本身动手建设包

Java中的包是可以本身建设的。我们可以将许多成果临近的类和接口放在同一个包中，以利便打点和利用。

建设包的根基要领

1.界说Public类；

2.首句加“Package 包名”；

3.将Java文件生成的Class放在以包名为目次名的目次中

4.在其它措施顶用“import 包名”就可以存取此包中的所有Public类。

包的建设和利用

//filename B.java package com.chen.test牎//界说一个包 public class B //界说一个类 public void add焛nt i焛nt j　 //两个数求和，并输出 System.out.println焛+j

上面的代码即是为了建设一个简朴的包：com.chen.test，我们将这个文件定名为B.java。此刻运行javac -d C焅 B.java编译该包（该呼吁在C盘下生成com\chen\test目次，并将编译功效生存在B.class中）。此刻我们进入C焅com\chen\test目次可以看到编译生成的Class文件也包括在内了。

OK，此刻这个包已经建设好了，这时需要你做的是把C焅com\chen\test配置在你的情况变量classpath里。

#p#副标题#e#

如何挪用包

此刻我们再用一个小措施来挪用上面建设的包：

//filename A.java import com.chen.test.潶//引入适才建设的包 public class A public static void main烻tring煠 args B test = new B test.add68　 //用add煛〉饔米远ㄒ灏

将上面的Java代码生存为C焅A.java熑缓蟊嘁耄簀avac C焅A.java。

提示：对付包文件B.java，你可以不编译煻只将它放到C焅com\chen\test目次下即可。要留意的是，A.java和B.java两个文件不行以放在沟通目次下，这样就会堕落。

Java文档及Javadoc

除了包之外，Java文档也是Java编程中很是重要的一个观念。Java文档就是Java措施的辅佐文档。一般环境下，我们先写好辅佐文档，再操作东西Javadoc来生成相应的文档。Javadoc是JDK提供的一个文档生成东西，它操作Java编译措施Javac对措施代码源文件中的声明和文档注释举办语法阐明，并在默认环境下生成一组HTML文档来描写类、内部类、接口、结构函数、要领和域。Javadoc注释以“/潰”开始，以“/”竣事，内里可以包括普通文本、HTML标志和Javadoc标志。Javadoc只处理惩罚源文件中在类/接口界说、要领、域、结构器之前的注释，忽略其它处所的注释。

把握Javadoc

此刻我们先用一个例程来说明Javadoc标志的意义：

/ 澪业腏avaDoc测试措施--JavaDocTest 滰author <a href=http//www.csdn.net>warton2003 西安</a> test<--这里可以嵌入HTML煴揪湮狧TML注释--> 滰version 0.1 2004/01/01 / public class JavaDocTest

/
澰趍ain 　中要利用字符串
滰see #main焜ava.lang.String
/
static String SDisplay
/
澫允綣avadoc测试
滰param args 呼吁行参数
滰return 没有返回值
/
public static void main烻tring args

SDisplay = ″Javadoc测试″
System.out.println SDisplay

#p#副标题#e#

#p#分页标题#e#

在这个Java措施内里，利用了大量的Javadoc标志、文本以及HTML标志。Javadoc标志以“/潰”开始，表白这些都是Java代码的注释。“@”开头的标志就是Javadoc标志。

Javadoc标志有两种：独立（Standalone）标志和内联（Inline）标志。独立标志也就是那些常见的标志，如@param、@return和@author等；另一种范例的标志是内联标志熣庵直昙遣捎氓烜tag牭男问舰它答允开拓者建设超等链接从注释部门链接到其它的Javadoc页面可能本页面的其它处所。

提示：在Java源措施里正确利用Javadoc标志长短常须要的注释习惯，将有助于Javadoc自动以源代码文件生成完整的名目化API文档。

OK，那么我们先看看Javadoc是如何生成大度的文档!将上面的代码生存到JavaDocTest.java并编译。

运行：javadoc -private -d doc -auth

or -version JavaDocTest.java

这时，Javadoc措施会按照JavaDocTest.java生成一个doc目次，内里有许多HTML文件，这些就是Javadoc生成的API辅佐文档。

Javadoc呼吁行语法

光会利用标志还不能很好操作Javadoc提供的成果，必需能利用它的呼吁行才行。最后向各人先容一下简朴的Javadoc呼吁。

Javadoc的呼吁行语法如下：

javadoc options packagenames sourcefiles @files

提示：对付一般的应用，我们只须利用javadoc yourjavafile.java这样的呼吁行生成辅佐文档就行了。假如你需要定制辅佐文档，才会用到参数，一般环境下你可以利用javadoc help呼吁来查察Javadoc的辅佐文档。

总之，Javadoc提供了完整类型的API文档成果。在软件项目打点和开拓中，公道地利用Javadoc不只可以淘汰开拓时的文档事情量，提高效率，并且还很是有利于未来软件的修改和维护。

Javadoc标志的一些具体说明：

@author指定生成文档中的“作者”项，可以指定多个author。在左面的代码中，author后头还加了一个HTML标志<a>，用来链接URL。 都是HTML标志，<– –>则是HTML注释。

@version 指定版本信息。

@see标志是较量巨大的。@see ″string″ 为“string”添加文本项，不发生任何链接。@see <a href=″URL#Value″>Label</a> 利用HTML标志发生链接。@see package.class#member Label。

@param标志用来描写参数。

@return标志用来描写返回值。

@link为内联标志，内联标志的凡是名目是：烜linkpackage.class#member label

提示：Label是位于注释中间的文本，package.class#member指向一个详细的类可能要领。以下是一些例子：

链接到同一类的属性，利用：@link#KEY

链接到同一类的要领，利用：烜link#getComponentAt焛nt　getComponentAt

链接到其它类，利用@linkjava.util.Map Map

当前位置：以往代写 > JAVA 教程 >Java中的包和文档