JavaDoc命令使用说明

合集下载

Javadoc自动生成帮助文档

Javadoc自动生成帮助文档

JAVADOC:自动生成你的程序开发文档当初学习编程序的时候,就从来没有想过要给自己写的那几个程序编写一份完整的文档,所有的注释都仅仅是为了自己当时能够想起这段代码到底是干什么的,没有人想过这些代码的升级、共享问题。

但是,开始做商业软件之后,一切都变了,尤其是大型的团队开发项目中。

大家也许注意到了,java的API文档总是紧紧跟随着JSDK的版本的提高而保持着最新的状态。

试想一下,手工维护这么复杂的文档可能吗?当然不可能,这一切都是javadoc这个小程序的功劳(当然也有java类库作者们做程序注释的一份功劳)。

API文档就是用它根据最新的源代码自动生成的,一切都是这么容易——只需要你把本来就要写的注释写得更规范一些,再稍微详细一些。

然而,大家似乎好像根本就没有意识到它的存在,很少有人会用它来为自己的程序生成文档。

不知道,你现在是否对它有了兴趣?好吧,下面我们就开始这个令人轻松的自动文档生成之旅。

【如何插入注释】javadoc为你生成代码不是凭空来的,也不是它会自动分析你的代码——每个人都有自己的代码风格,如果要进行分析翻译恐怕还是机器码更容易生成百倍。

它的分析机制依赖于你按照规范为你的代码添加应有而足够的注释。

只有你老老实实写注释,才有可能把以前需要做双份的工作一次做了。

Javadoc工具可以从下列对象中提取出信息:· 包。

· 公共类。

· 公共接口。

· 公共或者受保护的方法。

· 公共或者受保护的变量/常数。

针对每一种特性,你都应该提供一条注释。

每一条注释都要以/**打头,以*/结尾。

在每条/** …… */文档注释可包括任意格式的文字。

它的第一个句子应该是一个总结性的语句,javadoc会自动把它提出来制作总结页。

当然,这里你完全可以使用一些HTML的记号,例如<I>表示斜体;...表示等宽的“打印机”字体;<B>表示粗体;甚至用包括一副图象等等。

java三种注释

java三种注释

java三种注释
java三种注释
1.java规定了三种注释⽅式:单⾏注释、多⾏注释、⽂档注释
2.单⾏注释和多⾏注释的作⽤:
对所写的程序进⾏解释和说明,增强可读性
调试所写的代码:例如对部分代码注释,进⾏运⾏来找到代码错误的地⽅
特点:单⾏注释和多⾏注释,注释的内容不参与编译
单⾏注释
格式:
class helloJava{
//单⾏注释:如下的main⽅法是程序的⼊⼝!
public static void main(String args[]){
//单⾏注释:如下的语句表⽰输出到控制台
System.out.println("Hello World!");
}
}
多⾏注释
格式:
/*
这⾥是多⾏注释
*/
⽂档注释(java特有)
格式:
/**
@author 指定java程序的作者
@version 指定源⽂件的版本
*/
注释内容可以被JDK提供的⼯具Javadoc所解析,⽣成⼀套以⽹页⽂件形式体现的该程序的说明⽂档命令: javadoc -d Myjavadoc -author -version 1.2注释.java
解释:命令⾏格式为Javadoc -d ⽂件夹名字 -author -version ⽂件名.Java
⽂件夹是⾃⼰随便起的,会被放在与Java⽂件相同的⽂件⽬录下。

注意:多⾏注释不能够嵌套使⽤。

【Java】class.jar和sources.jar及javadoc.jar三种jar包

【Java】class.jar和sources.jar及javadoc.jar三种jar包

【Java】class.jar和sources.jar及javadoc.jar三种jar包⼀、普及jar包知识 例如(举例⼦解释)类⽂件(.class) test-java-1.0-SNAPSHOT.jar⽂档包(API) test-java-1.0-SNAPSHOT-javadoc.jar资源包(code) test-java-1.0-SNAPSHOT-sources.jar⼆、使⽤⽅法1.类⽂件(.class) test-java-1.0-SNAPSHOT.jar 反编译,最暴⼒直接的⽅法,将jar包拖进IDEA⾥查看2.⽂档包(API) test-java-1.0-SNAPSHOT-javadoc.jar 解压该⽂件,打开index.html查看3.资源包 test-java-1.0-SNAPSHOT-sources.jar 拖进IDEA直接查看⼆、⽣成⽅法1.类⽂件(.class) test-java-1.0-SNAPSHOT.jar 直接使⽤maven打包⽣成即可2.⽂档包(API) test-java-1.0-SNAPSHOT-javadoc.jar 使⽤ maven-javadoc-plugin 插件⽣成javadoc.jar3.资源包 test-java-1.0-SNAPSHOT-sources.jar 使⽤ maven-source-plugin 插件⽣成sources.jar完整pom⽂件如下:1<?xml version="1.0" encoding="UTF-8"?>2<project xmlns="/POM/4.0.0"3 xmlns:xsi="/2001/XMLSchema-instance"4 xsi:schemaLocation="/POM/4.0.0 /xsd/maven-4.0.0.xsd">5<modelVersion>4.0.0</modelVersion>67<groupId>com.test</groupId>8<artifactId>test-java</artifactId>9<version>1.0-SNAPSHOT</version>10<dependencies>11<dependency>12<groupId>junit</groupId>13<artifactId>junit</artifactId>14<version>4.12</version>15<scope>compile</scope>16</dependency>17</dependencies>1819<build>2021<plugins>22<plugin>23<!-- Maven 编译插件24指定maven编译的jdk版本,如果不指定,25 maven3默认⽤jdk 1.5 maven2默认⽤jdk1.3 -->26<groupId>org.apache.maven.plugins</groupId>27<artifactId>maven-compiler-plugin</artifactId>28<version>3.8.1</version>29<configuration>30<!-- ⼀般⽽⾔,target与source是保持⼀致的,但是,有时候为了让程序能在其他版本的jdk中运⾏(对于低版本⽬标jdk,源代码中不能使⽤低版本jdk中不⽀持的语法),会存在target不同于source的情况 --> 31<source>1.8</source><!-- 源代码使⽤的JDK版本 -->32<target>1.8</target><!-- 需要⽣成的⽬标class⽂件的编译版本 -->33<encoding>UTF-8</encoding><!-- 字符集编码 -->34<verbose>true</verbose>35<showWarnings>true</showWarnings>36<fork>true</fork><!-- 要使compilerVersion标签⽣效,还需要将fork设为true,⽤于明确表⽰编译版本配置的可⽤ -->37<executable><!-- path-to-javac --></executable><!-- 使⽤指定的javac命令,例如:<executable>${JAVA_1_4_HOME}/bin/javac</executable> -->38<compilerVersion>1.3</compilerVersion><!-- 指定插件将使⽤的编译器的版本 -->39<meminitial>128m</meminitial><!-- 编译器使⽤的初始内存 -->40<maxmem>512m</maxmem><!-- 编译器使⽤的最⼤内存 -->41<!-- <compilerArgument>-verbose -bootclasspath ${java.home}\lib\rt.jar</compilerArgument>&lt;!&ndash; 这个选项⽤来传递编译器⾃⾝不包含但是却⽀持的参数选项 &ndash;&gt;-->42</configuration>43</plugin>4445<!-- ⽣成javadoc⽂档包的插件 -->46<plugin>47<groupId>org.apache.maven.plugins</groupId>48<artifactId>maven-javadoc-plugin</artifactId>49<version>3.2.0</version>50<executions>51<execution>52<id>attach-javadocs</id>53<goals>54<goal>jar</goal>55</goals>56</execution>57</executions>58</plugin>5960<!-- ⽣成sources源码包的插件 -->61<plugin>62<groupId>org.apache.maven.plugins</groupId>63<artifactId>maven-source-plugin</artifactId>64<version>3.2.1</version>65<configuration>66<attach>true</attach>67</configuration>68<executions>69<execution>70<!-- 在package阶段之后会执⾏源代码打包 -->71<phase>package</phase>72<goals>73<goal>jar-no-fork</goal>74</goals>75</execution>76</executions>77</plugin>78</plugins>79</build>8081</project>配置好插件后,使⽤maven package命令既能在target⽬录中查看到三个jar包 命令:mvn package如果要把三种jar包安装到本地仓库 命令:mvn install如果要把三种jar包发布到远程仓库 命令:mvn deploy。

java文档注释规范(一)

java文档注释规范(一)

java⽂档注释规范(⼀)https:///huangsiqian/article/details/82725214Javadoc⼯具将从四种不同类型的“源”⽂件⽣成输出⽂档:Java语⾔类的源⽂件(.java),包注释⽂件,概述注释⽂件和其他未处理的⽂件。

包注释⽂件(Package Comment File)每个包都有⾃⼰的⽂档注释。

有两种⽅式来创建包注释⽂件:package-info.java - 可以包含包的声明,包注解(anotation),包注释和Javadoc 标签(tag)。

包注释放在包声明之前。

这是JDK 5.0新引⼊的特性。

如下。

File: java/applet/package-info.java 注意:⽂档注释块内部⾏⾸的*号是可选的/*** Provides the classes necessary to create an applet and the classes an applet uses* to communicate with its applet context.* <p>* The applet framework involves two entities:* the applet and the applet context. An applet is an embeddable window (see the* {@link java.awt.Panel} class) with a few extra methods that the applet context* can use to initialize, start, and stop the applet.** @since 1.0* @see java.awt*/package ng.applet;package.html - 只能包含包注释和Javadoc标签,不能包含包注解。

JDK(Java Development Kit,Java开发包,Java开发工具)是一个写Java的

JDK(Java Development Kit,Java开发包,Java开发工具)是一个写Java的

JDK(Java Development Kit,Java开发包,Java开发工具)是一个写Java的applet 和应用程序的程序开发环境。

它由一个处于操作系统层之上的运行环境还有开发者编译,调试和运行用Java语言写的applet和应用程序所需的工具组成。

JDK(Java Development Kit)是Sun Microsystems针对Java开发员的产品。

自从Java 推出以来,JDK已经成为使用最广泛的Java SDK(Software development kit)。

JDK包含的基本组件包括:·javac –编译器,将源程序转成字节码·jar –打包工具,将相关的类文件打包成一个文件·javadoc –文档生成器,从源码注释中提取文档·jdb – debugger,查错工具JDK中还包括完整的JRE(Java Runtime Environment,Java运行环境),也被称为private runtime。

包括了用于产品环境的各种库类,以及给开发员使用的补充库,如国际化的库、IDL库。

JDK中还包括各种例子程序,用以展示Java API中的各部分。

从初学者角度来看,采用JDK开发Java程序能够很快理解程序中各部分代码之间的关系,有利于理解Java面向对象的设计思想。

JDK的另一个显著特点是随着Java (J2EE、J2SE 以及J2ME)版本的升级而升级。

但它的缺点也是非常明显的就是从事大规模企业级Java应用开发非常困难,不能进行复杂的Java软件开发,也不利于团体协同开发。

JDK一般有三种版本:SE(J2SE),standard edition,标准版,是我们通常用的一个版本EE(J2EE),enterpsise edtion,企业版,使用这种JDK开发J2EE应用程序,ME(J2ME),micro edtion,主要用于移动设备、嵌入式设备上的java应用程序Java开发工具(JDK)是许多Java专家最初使用的开发环境。

JDK常用命令详解

JDK常用命令详解

JDK常用命令详解JDK的命令详解(1)功能说明:rmic 为远程对象生成 stub 和 skeleton。

语法: rmic [ options ] package-qualified-class-name(s)补充说明: rmic 编译器根据编译后的 Java 类(含有远程对象实现)名,为远程对象生成stub 和 skeleton(远程对象是指实现 java.rmi.Remote 接口的对象)。

在 rmic 命令中所给的类必须是经 javac 命令成功编译且是完全包限定的类。

命令选项-classpath[路径] 指定 rmic 用于查询类的路径。

如果设置了该选项,它将覆盖缺省值或CLASSPATH 环境变量。

目录用冒号分隔。

-d[目录] 指定类层次的根目录。

此选项可用来指定 stub 和 skeleton 文件的目标目录。

-depend 使编译器考虑重新编译从其它类引用的类。

一般来说,它只重新编译从源代码引用的遗漏或过期的类。

-g 允许生成调试表格。

调试表格含有行号和局部变量的有关信息,即 Java 调试工具所使用的信息。

缺省情况下,只生成行号。

-J 与 -D 选项联用,它将紧跟其后的选项( -J 与 -D 之间无空格)传给 java 解释器。

-keepgenerated 为 stub 和 skeleton 文件保留所生成的 .java 源文件,并将这些源文件写到与 .class 文件相同的目录中,如果要指定目录,则使用 -d 选项。

-nowarn 关闭警告。

如果使用该选项,则编译器不输出任何警告信息。

-show 显示 rmic 编译器的 GUI(图形用户界面)。

输入一个或多个包限定类名(以空格分隔),并按回车键或“显示”按钮,创建 stub 和 skeleton。

-vcompat (缺省值)创建与 JDK 1.1 和 1.2 stub 协议版本都兼容的 stub 和 skeleton。

-verbose 使编译器和链接器输出关于正在编译哪些类和正在加载哪些类文件的信息。

javadoc使用方法

javadoc使用方法

javadoc使用方法
Javadoc是用来生成Java API文档的工具,使用方法如下:
1. 打开命令行终端。

2. 切换到目标文件所在的目录。

3. 输入“javadoc +文件名.java”命令,其中文件名应替换为要生成文档的Java源代码文件的名称。

例如,如果你要生成名为“”的文件的文档,你应该输入“javadoc ”。

4. 执行命令后,Javadoc将扫描指定的Java源代码文件并生成相应的API 文档。

5. 生成的API文档将保存在当前目录下,并命名为“”,其中“MyClass”应替换为源代码文件名。

此外,Javadoc还支持许多选项,可以用来定制生成的API文档。

例如,可以使用“-protected”选项来显示受保护/公共类和成员(默认),使用“-package”选项来显示软件包/受保护/公共类和成员,使用“-private”选项来显示所有类和成员等等。

这些选项可以通过在命令行中添加相应的参数来指定。

以上是Javadoc的基本使用方法,你可以通过阅读Javadoc的文档或在线教程来了解更多详细信息。

javadoc文档生成方式

javadoc文档生成方式

Javadoc文档生成方式1. 什么是Javadoc文档Javadoc文档是一种用于描述Java代码的文档标记语言。

它能够从代码中提取注释并生成可读性强的HTML格式文档,以帮助开发人员更好地理解和使用代码。

Javadoc文档通常包含类、方法、字段等的详细描述,包括功能、参数、返回值、异常等信息。

2. Javadoc文档的重要性Javadoc文档是Java开发中必不可少的一部分,具有以下几个重要作用:•提供代码的使用说明:Javadoc文档能够清晰地描述代码的功能和使用方法,方便其他开发人员快速了解和使用代码。

•促进团队协作:Javadoc文档可以作为团队协作的重要工具,通过统一的文档格式和规范,促进团队成员之间的沟通和协作。

•提高代码的可读性:Javadoc文档能够将代码的关键信息提取出来,并以易于阅读的方式展示出来,提高代码的可读性和可维护性。

•方便代码维护和重构:Javadoc文档中包含了代码的详细描述和设计意图,能够帮助开发人员更好地理解代码,从而方便代码的维护和重构。

3. Javadoc文档生成方式3.1 使用命令行工具生成Javadoc文档可以通过命令行工具生成,具体步骤如下:1.打开命令行终端,进入代码所在的目录。

2.使用以下命令生成Javadoc文档:javadoc -d <output-directory> <source-files>–-d指定生成的文档输出目录。

–<output-directory>为生成的文档输出目录的路径。

–<source-files>为需要生成文档的源代码文件或目录。

3.等待命令执行完成,生成的Javadoc文档将保存在指定的输出目录中。

3.2 使用集成开发环境(IDE)生成大多数集成开发环境(IDE)都提供了生成Javadoc文档的功能,具体步骤如下(以Eclipse为例):1.打开Eclipse,进入项目。

Ant标签详解--Java命令

Ant标签详解--Java命令

这一篇主要介绍与java相关标签的使用终于始重头戏了,Java部分们的重也中用处最多的部分。

1. <javac>编译java源文件成class文件。

<javac srcdir="${src}" destdir="${dest}" encoding="utf-8"bootclasspathref="project.classpath" includejavaruntime="true" includeantruntime="false" optimize="true" source="1.6" target="1.6"/>(1). srcdir:java源文件的文件夹,也可以在内部嵌套<src>标签(2). destdir:用于存放编译后class文件的文件夹,默认当前文件夹。

(3). includes:必须包括的文件模式的列表,以逗号或空格分隔。

如果忽略,将包括所有文件。

(4). includesfile:指定一个包含很多include的文件,同样可以用通配符来指定。

(5). excludes:必须排除的文件模式的列表,以逗号或空格分隔。

如果忽略,将不排除任何文件。

(6). excludesfile:指定一个包含很多exclude的文件,同样可以用通配符来指定。

(7). classpath: 编译所使用的classpath(8). sourcepath: 指定源资源文件夹。

默认指向srcdir(9). bootclasspath: 启动时设置classpath(10). classpathref:引用其他classpath(11). sourcepathref:引用其他源文件目录(12). bootclasspathref:启动时引用其他classpath设置(13). extdirs:扩展文件的路径。

《疯狂JAVA讲义》李刚上课笔记

《疯狂JAVA讲义》李刚上课笔记

第一章到第十二章day01Java开发前奏(第1章)IT行业硬件- 各种硬件,技术含量越高,价格越贵。

软件- 看不到,摸不着。

软件比硬件值钱得多!!!iPhone 5 - 5000制造成本400块——其他在品牌,在软件。

美国几乎不造硬件——硬件不如软件挣钱。

程序——软件的核心部分程序:当我们要做一件事情时,需要按一种既定的流程、步骤,依次完成每个过程,——最后结果就出来了。

真正的程序员,会影响他的生活习惯,做所有事情,都会有计划,有步骤。

计算机程序:驱动机器去为我们按既定流程、步骤去完成某件事情。

=======计算机是很蠢的!它只会按我们规定的步骤去做事======= Java能做什么?1. 做桌面软件。

——针对个人。

Java在桌面软件领域、并不流行。

MS,win8向“移动操作系统”转型。

2. 大型信息化系统。

(Java最擅长)——针对企业。

taobao(阿里软件)、各种银行系统、证券、电信、移动……3. 移动互联网软件。

——针对个人。

Android编程语言的运行机制程序:驱动机器去为我们按既定流程、步骤去完成某件事情。

能直接驱动计算机的——机器指令。

(难度非常大)→汇编→高级语言(C、Java……)高级语言编程:源代码就像“作文”一样,容易编写。

但高级语言的源代码,机器看不懂,但人容易看懂、容易编写。

学编程的所有工具安装准则:1. 不要安装在有空格的路径下。

2. 不要安装在有中文的路径下。

(1)安装JDK.(2)既然要使用Java开发,经常需要使用javac、java命令。

执行计算机命令的两个方法A。

每次运行命令时,都输入该命令的绝对路径。

——可行,坏处是麻烦。

B。

告诉系统,总是到某些目录下去找命令。

这就需要PATH环境变量:它的值是N条路径。

中间以分号隔开。

用于告诉操作系统,以后操作系统要找命令时,就依次在这N条路径中找,如果找到了,操作系统就执行这些命令。

如果没找到,操作系统就提示:“不是内部或外部命令,也不是可运行的程序”PATH环境变量的作用:告诉【操作系统】到哪些路径下去找【命令】。

javadoc注释规范

javadoc注释规范

javadoc注释规范javadoc做注释一. Java 文档// 注释一行/* ...... */ 注释若干行/** ...... */ 注释若干行,并写入 javadoc 文档通常这种注释的多行写法如下:/*** .........* .........*/javadoc -d 文档存放目录 -author -version 源文件名.java这条命令编译一个名为“源文件名.java”的 java 源文件,并将生成的文档存放在“文档存放目录”指定的目录下,生成的文档中 index.html 就是文档的首页。

-author 和 -version 两个选项可以省略。

二. 文档注释的格式1. 文档和文档注释的格式化生成的文档是 HTML 格式,而这些 HTML 格式的标识符并不是 javadoc 加的,而是我们在写注释的时候写上去的。

比如,需要换行时,不是敲入一个回车符,而是写入 <br>,如果要分段,就应该在段前写入 <p>。

文档注释的正文并不是直接复制到输出文件 (文档的 HTML 文件),而是读取每一行后,删掉前导的 * 号及 * 号以前的空格,再输入到文档的。

如/*** This is first line. <br>***** This is second line. <br>This is third line.*/2. 文档注释的三部分先举例如下/*** show 方法的简述.* <p>show 方法的详细说明第一行<br>* show 方法的详细说明第二行* @param b true 表示显示,false 表示隐藏* @return 没有返回值*/public void show(boolean b) {frame.show(b);}第一部分是简述。

文档中,对于属性和方法都是先有一个列表,然后才在后面一个一个的详细的说明简述部分写在一段文档注释的最前面,第一个点号 (.) 之前 (包括点号)。

java-Xbootclasspath的用法.

java-Xbootclasspath的用法.

java-Xbootclasspath的⽤法.昨晚使⽤eclipse的时候突然想到eclipse怎样去区分使⽤jdk1.4还是jdk1.5,我使⽤jdk1.4在eclipse运⾏⼀个java程序这时的command是 C:\j2sdk1.4.2_05\bin\javaw.exe -Xbootclasspath:C:\j2sdk1.4.2_05\lib\tools.jar;C:\j2sdk1.4.2_05\jre\lib\rt.jar;C:\j2sdk1.4.2_05\jre\lib\sunrsasign.jar;C:\j2sdk1.4.2_05\jre\lib\jsse.jar;C:\j2sdk1.4.2_05\jre\lib\jce.ja -classpath E:\Eclipse_WorkSpace\Eclipse_Work\DateTransform\classes;E:\Eclipse_WorkSpace\Eclipse_Work\DateTransform\lib\jtds-1.0.3.jar;E:\Eclipse_WorkSpace\Eclipse_Work\DateTransform\lib\poi-2.5.1-final-20040804.jar;E:\Eclipse_WorkSpace\Eclipse_Work\DateTransform\lib\poi-contrib-2.5.1-final-20040804.jar;E:\Eclipse_WorkSpace\Eclipse_Work\DateTransform\lib\poi-scratchpad-2.5.1-final-20040804.jar;E:\Eclipse_WorkSpace\Eclipse_Work\DateTransform\lib\commons-logging-1.0.2.jar;E:\Eclipse_WorkSpace\Eclipse_Work\DateTransform\lib\log4j-1.2.6.jar -Xdebug -Xnoagent -Xrunjdwp:transport=dt_socket,suspend=y,address=localhost:1160 com.dengyin.data.transform.DoingTxt 红⾊部分后⾯的那些包是在eclipse重设置好的.这是使⽤这些包作为启动类 .( set search path for bootstrap classes and resources )然⽽当我使⽤jdk1.5的时候的command是 C:\jdk1.5.0_03\bin\javaw.exe -classpathE:\Eclipse_WorkSpace\Eclipse_Work\DateTransform\classes;E:\Eclipse_WorkSpace\Eclipse_Work\DateTransform\lib\jtds-1.0.3.jar;E:\Eclipse_WorkSpace\Eclipse_Work\DateTransform\lib\poi-2.5.1-final-20040804.jar;E:\Eclipse_WorkSpace\Eclipse_Work\DateTransform\lib\poi-contrib-2.5.1-final-20040804.jar;E:\Eclipse_WorkSpace\Eclipse_Work\DateTransform\lib\poi-scratchpad-2.5.1-final-20040804.jar;E:\Eclipse_WorkSpace\Eclipse_Work\DateTransform\lib\commons-logging-1.0.2.jar;E:\Eclipse_WorkSpace\Eclipse_Work\DateTransform\lib\log4j-1.2.6.jar -Xdebug -Xnoagent -Xrunjdwp:transport=dt_socket,suspend=y,address=localhost:1635 com.dengyin.data.transform.DoingTxt 我们看到这时并没有-Xbootclasspath参数,我们知道java程序中的所有依赖的类都会去classpath⾥⾯照.这时我想-Xbootclasspath做的⼯作应该时被javaw.exe做了,把那些系统必须的那些bootClass设置到了bootClasspath⾥⾯了 .(以上想法时我个⼈的猜测,我上⽹找了但是没有找到满意的答案) 当你装好了jdk1.5时,它会拷贝⼀份java.exe到windows(winNt)⽬录下⾯,这样你就可以不⽤设置JAVA_HOME然后把%JAVA_HOME%\bin放到系统的path⽬录了, ⽽且这时java.exe会⾃⼰设置好bootClass,这样你就不⽤在系统的环境变量⾥⾯设置ClassPath了. -Xbootclasspath:<directories by="" separated="" files="" and="">set search path for bootstrap classes and resources-Xbootclasspath/a:<directories by="" separated="" files="" and="">append to end of bootstrap class path-Xbootclasspath/p:<directories by="" separated="" files="" and="">prepend in front of bootstrap class path</directories></directories></directories> 最后给出些%JAVA_HOME%\bin⾥⾯⼀些exe的⽤法.(⽹上找的) java.exe⽤法:java [-options] class [args...](to execute a class)或 java -jar [-options] jarfile [args...](to execute a jar file)where options include:-client to select the "client" VM-server to select the "server" VM-hotspot is a synonym for the "client" VM [deprecated]The default VM is client.-cp -classpath <directories by="" separated="" files="" and="">set search path for application classes and resources-D<name>=<value>set a system property-verbose[:class|gc|jni]enable verbose output-version print product version and exit-showversion print product version and continue-? -help print this help message-X print help on non-standard options-ea[: <packagename>...|:<classname>]-enableassertions[: <packagename>...|:<classname>]enable assertions-da[: <packagename>...|:<classname>]-disableassertions[: <packagename>...|:<classname>]disable assertions-esa | -enablesystemassertionsenable system assertions-dsa | -disablesystemassertionsdisable system assertionsjava -X-Xmixed mixed mode execution (default)-Xint interpreted mode execution only-Xbootclasspath:<directories by="" separated="" files="" and="">set search path for bootstrap classes and resources-Xbootclasspath/a:<directories by="" separated="" files="" and="">append to end of bootstrap class path-Xbootclasspath/p:<directories by="" separated="" files="" and="">prepend in front of bootstrap class path-Xnoclassgc disable class garbage collection-Xincgc enable incremental garbage collection-Xloggc:<file> log GC status to a file with time stamps-Xbatch disable background compilation-Xms<size> set initialJava heap size-Xmx<size> set maximum Java heap size-Xss<size> set java thread stack size-Xprof output cpu profiling data-Xrunhprof[:help]|[:=<value>, ...]perform JVMPI heap, cpu, or monitor profiling-Xdebug enable remote debugging-Xfuture enable strictest checks, anticipating future default-Xrs reduce use of OS signals by Java/VM (see documentation)The -X options are non-standard and subject to change without notice.====================javac.exe⽤法:javac <选项> <源⽂件>可能的选项包括:-g ⽣成所有调试信息-g:none ⽣成⽆调试信息-g:{lines,vars,source} ⽣成只有部分调试信息-O 优化;可能妨碍调试或者增⼤类⽂件-nowarn ⽣成⽆警告-verbose 输出关于编译器正在做的信息-deprecation 输出使⽤了不⿎励使⽤的API的源程序位置-classpath <路径> 指定⽤户类⽂件的位置-sourcepath <路径> 指定输⼊源⽂件的位置-bootclasspath <路径> 覆盖⾃举类⽂件的位置-extdirs <⽬录(多个)> 覆盖安装的扩展类的位置-d <⽬录> 指定输出类⽂件的位置-encoding <编码> 指定源⽂件中所⽤的字符集编码-target <版本> ⽣成指定虚拟机版本的类⽂件-help Print a synopsis of standard options====================appletviewer.exe⽤法:appletviewer <options> url其中, <options> 包括:-debug 在 Java 调试器中启动 applet ⼩程序查看器-encoding <encoding> 指定由 HTML ⽂件使⽤的字符编码-J<runtime flag=""> 向 Java 解释器传递参数-J 选项不是标准选项,如有更改,不另⾏通知。

idea javadoc文档的生成方法

idea javadoc文档的生成方法

idea javadoc文档的生成方法【实用版3篇】目录(篇1)1.介绍 JavaDoc 文档2.JavaDoc 文档的生成方法3.使用 IDEA 自动生成 JavaDoc 文档4.手动编写 JavaDoc 文档5.结论正文(篇1)一、介绍 JavaDoc 文档JavaDoc 是 Java 开发中的一种文档编写标准,它可以描述 Java 类、方法、成员变量等的详细信息。

JavaDoc 文档通常以 HTML 格式生成,并且可以被 IDEA 等 Java 开发工具自动生成。

二、JavaDoc 文档的生成方法JavaDoc 文档的生成方法主要有两种:使用 IDEA 自动生成和手动编写。

1.使用 IDEA 自动生成 JavaDoc 文档IDEA 是一款强大的 Java 开发工具,它可以自动生成 JavaDoc 文档。

具体操作步骤如下:(1)打开 IDEA,导入 Java 项目。

(2)在项目中选择需要生成 JavaDoc 的类或方法,右键点击,选择“生成 JavaDoc”。

(3)IDEA 会自动生成 JavaDoc 文档,并将其保存在项目指定的输出目录中。

2.手动编写 JavaDoc 文档手动编写 JavaDoc 文档需要遵循一定的规范,例如使用特定的注释标签、指定文档生成工具等。

下面是一个简单的手动编写 JavaDoc 文档的示例:```java/*** 这是一个简单的 JavaDoc 注释* @author YourName* @version 1.0* @since JDK 1.8*/public class MyClass {// 类的成员变量和方法}```三、结论JavaDoc 文档是 Java 开发中重要的文档之一,它可以帮助开发者更好地理解和使用 Java 类、方法等。

使用 IDEA 可以方便地生成 JavaDoc 文档,而手动编写 JavaDoc 文档则需要遵循一定的规范。

目录(篇2)1.介绍 Javadoc2.Javadoc 的生成方法3.Javadoc 生成文档的步骤4.常见问题与解决方法5.总结正文(篇2)一、介绍 JavadocJavadoc 是 Java 开发中的一种文档生成工具,它可以从 Java 源代码中提取类、方法、成员变量等信息,并生成 HTML 格式的文档。

java之javadoc命令

java之javadoc命令

java之javadoc命令【javadoc命令的⽤法】1.java源⽂件⾥,注释以/**开始并以*/结束,⾥⾯可以包含普通⽂件,HTML标记和javaDoc标记。

这些将构成javaDoc⽂档。

2.javadoc命令只能处理java源⽂件中在类声明,接⼝声明,成员⽅法声明,成员变量声明及构造⽅法声明之前的注释,忽略位于其它地⽅的注释。

如局部变量前的注释,即使符合规范也会被javadoc命令忽略。

3.常见的javadoc标记@version 指定版本信息@since 指定最早出现在那个版本@author 指定作者@see ⽣成参考其它javaDoc⽂档的链接@link ⽣成参考其它javadoc⽂档的链接,它和@see标记的区别在于@link标记能够嵌⼊到注释语句中,为注释语句中的特定词汇⽣成链接。

@deprecated ⽤来标明被注释的类,变量或⽅法已经不提倡使⽤,在将来的版本中可能被废弃。

@param 描述⽅法的参数@return 描述⽅法的返回值@throws 描述⽅法抛出的异常,指明抛出异常的条件4.javadoc命令既可以处理包,也可以处理java源⽂件.javadoc [option] [packagenames] [sourcefiles]javadoc命令的主要选项:-public 仅为public访问级别的类及类的成员⽣成javaDoc⽂档-proteceted 仅为public和protected访问级别的类及类的成员⽣成javadoc⽂档.(默认选项)-package 仅为public,protected和默认访问级别的类及类的成员⽣成javaDoc⽂档-private 为public,protected,默认和private访问级别的类及类的成员⽣成javadoc⽂档-version 解析@version标记-author 解析@author标记-splitindex 将索引分为每个字母对应⼀个索引⽂件-sourcepath <pathlist> 指定java源⽂件的路径-classpath <pathlist> 指定classpath-d <directory> 指定javaDoc⽂档的输出⽬录javadoc命令的⼏个选项的⽤法:-public,-protected,-package和-private这4个选项⽤于指定输出那些访问级别的类和成员的javaDoc⽂档.其中protected为默认选项。

Java常用命令汇总

Java常用命令汇总

Java常⽤命令汇总这篇⽂章就主要向⼤家展⽰了Java编程中常⽤的命令,下⾯看下具体内容。

1、javac将⽂件编译成.class⽂件⽤法: javac <options> <source files>其中, 可能的选项包括:-g ⽣成所有调试信息-g:none 不⽣成任何调试信息-g:{lines,vars,source} 只⽣成某些调试信息-nowarn 不⽣成任何警告-verbose 输出有关编译器正在执⾏的操作的消息-deprecation 输出使⽤已过时的 API 的源位置-classpath <路径> 指定查找⽤户类⽂件和注释处理程序的位置-cp <路径> 指定查找⽤户类⽂件和注释处理程序的位置-sourcepath <路径> 指定查找输⼊源⽂件的位置-bootclasspath <路径> 覆盖引导类⽂件的位置-extdirs <⽬录> 覆盖所安装扩展的位置-endorseddirs <⽬录> 覆盖签名的标准路径的位置-proc:{none,only} 控制是否执⾏注释处理和/或编译。

-processor <class1>[,<class2>,<class3>...] 要运⾏的注释处理程序的名称; 绕过默认的搜索进程-processorpath <路径> 指定查找注释处理程序的位置-d <⽬录> 指定放置⽣成的类⽂件的位置-s <⽬录> 指定放置⽣成的源⽂件的位置-implicit:{none,class} 指定是否为隐式引⽤⽂件⽣成类⽂件-encoding <编码> 指定源⽂件使⽤的字符编码-source <发⾏版> 提供与指定发⾏版的源兼容性-target <发⾏版> ⽣成特定 VM 版本的类⽂件-version 版本信息-help 输出标准选项的提要-A关键字[=值] 传递给注释处理程序的选项-X 输出⾮标准选项的提要-J<标记> 直接将 <标记> 传递给运⾏时系统-Werror 出现警告时终⽌编译@<⽂件名> 从⽂件读取选项和⽂件名2、java执⾏ .class⽂件,若类中没有main函数,则不能执⾏。

JAVA控制台命令详解

JAVA控制台命令详解

JAVA控制台命令详解(一)命令概览javac:Java编译器,将Java源代码换成字节代java:Java解释器,直接从类文件执行Java应用程序代码appletviewer(小程序浏览器):一种执行HTML文件上的Java小程序类的Java浏览器javadoc:根据Java源代码及其说明语句生成的HTML文档jdb:Java调试器,可以逐行地执行程序、设置断点和检查变量javah:产生可以调用Java过程的C过程,或建立能被Java程序调用的C过程的头文件Javap:Java反汇编器,显示编译类文件中的可访问功能和数据,同时显示字节代码含义jar:多用途的存档及压缩工具,是个java应用程序,可将多个文件合并为单个JAR归档文件。

htmlConverter——命令转换工具。

native2ascii——将含有不是Unicode或Latinl字符的的文件转换为Unicode编码字符的文件。

serialver——返回serialverUID。

语法:serialver[show]命令选项show是用来显示一个简单的界面。

输入完整的类名按Enter键或"显示"按钮,可显示serialverUID。

(二)命令详细介绍补充详细:1.javac.exe用法:javac<选项><源文件>可能的选项包括:-g生成所有调试信息-g:none生成无调试信息-g:{lines,vars,source}生成只有部分调试信息-O优化;可能妨碍调试或者增大类文件-nowarn生成无警告-verbose输出关于编译器正在做的信息-deprecation输出使用了不鼓励使用的API的源程序位置-classpath<路径>指定用户类文件的位置-sourcepath<路径>指定输入源文件的位置-bootclasspath<路径>覆盖自举类文件的位置-extdirs<目录(多个)>覆盖安装的扩展类的位置-d<目录>指定输出类文件的位置-encoding<编码>指定源文件中所用的字符集编码-target<版本>生成指定虚拟机版本的类文件-help Print a synopsis of standard options2.Java.exeJava在运行已编译完成的类时,是通过java虚拟机来装载和执行的,java虚拟机通过操作系统命令JAVA_HOME\bin\java–option来启动,-option为虚拟机参数,JAVA_HOME为JDK安装路径,通过这些参数可对虚拟机的运行状态进行调整,掌握参数的含义可对虚拟机的运行模式有更深入理解。

javadoc用法

javadoc用法

Javadoc 是Java 平台提供的一种工具,用于从Java 源代码中提取文档注释,并生成相应的API 文档。

下面是Javadoc 的基本用法:1. **编写文档注释**:在Java 源代码中,使用特定的注释格式编写文档注释。

Javadoc 注释以`/**` 开始,以`*/` 结束。

例如:```java/*** 这是一个示例类,用于演示Javadoc的用法*/public class MyClass {/*** 这是一个示例方法,用于演示Javadoc的用法* @param param 示例参数* @return 示例返回值*/public int myMethod(int param) {// 方法实现}}```2. **生成文档**:在命令行中使用`javadoc` 命令来生成文档。

假设我们有一个名为`MyClass.java` 的源文件,可以执行以下命令生成文档:```bashjavadoc MyClass.java```这将会在当前目录下生成一个名为`index.html` 的文档文件,其中包含了`MyClass` 类和`myMethod` 方法的文档信息。

3. **自定义生成选项**:`javadoc` 命令支持许多自定义选项,比如指定生成文档的输出目录、包含的源文件、排除的源文件等。

例如:```bashjavadoc -d docs -sourcepath src -subpackages com.mypackage```这个命令将会生成文档到名为`docs` 的目录中,包含`src` 目录下`com.mypackage` 包及其子包中的所有源文件的文档信息。

Javadoc 工具还支持许多其他选项和标签,用于自定义生成的文档内容。

你可以在生成的文档中包含类、方法、字段的说明、参数、返回值、异常、作者、版本等信息。

希望这些信息能够帮助你理解Javadoc 工具的基本用法。

JavaDOC注释使用方法

JavaDOC注释使用方法

JavaDOC注释使用方法目录前言一. Java 文档和 javadoc二. 文档注释的格式1. 文档注释的格式化2. 文档注释的三部分三. 使用 javadoc 标记1. @see 的使用2. 使用 @author、@version 说明类3. 使用 @param、@return 和 @exception 说明方法四. javadoc 命令前言Java 的语法与 C++ 及为相似,那么,你知道 Java 的注释有几种吗?是两种?//注释一行/* ...... */注释若干行不完全对,除了以上两种之外,还有第三种,文档注释:/** ...... */注释若干行,并写入 javadoc 文档通常这种注释的多行写法如下:/*** .........* .........*/一. Java 文档和 javadocJava 程序员都应该知道使用 JDK 开发,最好的帮助信息就来自 SUN 发布的 Java 文档。

它分包、分类详细的提供了各方法、属性的帮助信息,具有详细的类树信息、索引信息等,并提供了许多相关类之间的关系,如继承、实现接口、引用等。

Java 文档全是由一些 html 文件组织起来的,在 SUM 的站点上可以下载它们的压缩包。

但是你肯定想不到,这些文档我们可以自己生成。

安装了 JDK 之后,安装目录下有一个 src.jar 文件或者 src.zip 文件,它们都是以 ZIP 格式压缩的,可以使用 WinZip 解压。

解压之后,我们就可以看到分目录放的全是 .java 文件。

是了,这些就是 Java 运行类的源码了,非常完整,连注释都写得一清二楚……不过,怎么看这些注释都有点似曾相识的感觉?这就不奇怪了,我们的迷底也快要揭开了。

如果你仔细对比一下 .java 源文件中的文档注释 (/** ... */) 和 Java 文档的内容,你会发现它们就是一样的。

Java 文档只是还在格式和排版上下了些功夫。

JavaDoc命令入门

JavaDoc命令入门

JavaDoc命令⼊门JavaDoc命令javadoc命令是⽤来⽣成⾃⼰API⽂档的/**+回车参数信息@author 作者名@version 版本号@since 指明需要最早使⽤的jdk版本@param 参数名@return 返回值情况@throws 异常抛出情况IDEA中:在⽅法上直接输⼊/**+回车,可直接⽣成⽅法的注释在类上直接输⼊/**+回车,可直接⽣成类的注释/*** @author Ryan* @version 1.0* @since 1.0*/public class doc {String name;/**** @param name* @return* @throws Exception*/public String test(String name) throws Exception{return name;}}⽣成API⽂档在IDEA中,选择要⽣成API⽂档的类,右击,选择open in explorer在地址栏(盘符)前加上cmd空格后回车,进⼊命令⾏模式javadoc -encoding UTF-8 -charset UTF-8 doc.javaencoding:选择UTF-8进⾏编码charset:使⽤UTF-8字符集为了编译不产⽣乱码⽣成的⽂件中index.html就是API⽂档了在IDEA中⽣成API⽂档选中要⽣成API⽂档的项⽬、模块、类,在菜单栏选则tools–>Generate javaDoc…设置输出路径和编码格式(-encoding utf-8 -charset utf-8)。

javadoc命令的注释语句

javadoc命令的注释语句

javadoc命令的注释语句
Javadoc命令是一种通过特定语句在Java源代码中添加注释的方式,用于生成API文档。

以下是常见的Javadoc注释语句:
1. 类注释:
/**
* 类的描述信息
*/
2. 方法注释:
/**
* 方法的描述信息
* @param 参数名参数描述
* @return 返回值描述
* @throws 异常类型异常描述
*/
3. 字段注释:
/**
* 字段的描述信息
*/
4. 构造方法注释:
/**
* 构造方法的描述信息
* @param 参数名参数描述
* @throws 异常类型异常描述
*/
5. 参数注释:
/**
* @param 参数名参数描述
*/
6. 返回值注释:
/**
* @return 返回值描述
*/
7. 异常注释:
/**
* @throws 异常类型异常描述
*/
8. 通用注释:
/**
* @deprecated 说明方法或类不推荐使用,建议使用其他替代的方法或类
* @version 文档的版本信息
* @author 作者名
* @see 关联的其他类或方法
* @since 所支持的最低版本
* @serial 字段的序列化说明
* @serialField 字段的序列化说明,可包含多个
* @serialData 自定义序列化数据的格式说明
* @inheritDoc 继承父类的文档注释
*/
以上是Javadoc命令的基本注释语句,通过这些语句可以生成详细的API文档,方便其他开发人员使用和理解代码。

  1. 1、下载文档前请自行甄别文档内容的完整性,平台不提供额外的编辑、内容补充、找答案等附加服务。
  2. 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
  3. 3、如文档侵犯您的权益,请联系客服反馈,我们会尽快为您处理(人工客服工作时间:9:00-18:30)。
JavaDoc 命令使用说明
作者:未知
转贴自:网络收藏
点击数:25
javadoc 的命令行语法如下: javadoc [ options ] [ packagenames ] [ sourcefiles ] [ @files ] 参数可以按照任意顺序排列。下面分别就这些参数和相关的一些内容进行说明: " Packagenames 包列表。这个选项可以是一系列的包名(用空格隔开),例如 ng ng.reflect java.awt。不过,因为 javadoc 不递归作用于子包,不允许对包名使用通配符;所以你必须显示地列出希 望建立文档的每一个包。 " Sourcefiles 源文件列表。这个选项可以是一系列的源文件名(用空格隔开),可以使用通配符。javadoc 允许四种源文件:类源代码文件、包描述文件、总体概述文件、其他杂文件。 ◇ 类源代码文件:类或者接口的源代码文件。 ◇ 包描述文件:每一个包都可以有自己的包描述文件。包描述文件的名称必须是 package.html,与包 的.java 文件放置在一起。包描述文件的内容通常是使用 HTML 标记写的文档。javadoc 执行时将自动寻找 包描述文件。如果找到,javadoc 将首先对描述文件中<body></body>之间的内容进行处理,然后把处理结 果放到该包的 Package Summary 页面中,最后把包描述文件的第一句(紧靠<body>)放到输出的 Overview summary 页面中,并在语句前面加上该包的包名。 ◇ 总体概述文件:javadoc 可以创建一个总体概述文件描述整个应用或者所有包。总体概述文件可以被任 意命名,也可以放置到任意位置。-overview 选项可以指示总体概述文件的路径和名称。总体概述文件的 内容是使用 HTML 标记写的文档。javadoc 在执行的时候,如果发现-overview 选项,那么它将首先对文件 中<body></body>之间的内容进行处理;然后把处理后的结果放到输出的 Overview summary 页面的底部; 最后把总体概述文件中的第一句放到输出的 Overview summary 页面的顶部。 ◇ 其他杂文件:这些文件通常是指与 javadoc 输出的 HTML 文件相关的一些图片文件、Java 源代码文件 (.java)、Java 程序(.class)、Java 小程序(Applets)、HTML 文件。这些文件必须放在 doc-files 目录中。每一个包都可以有自己的 doc-files 目录。举个例子,你希望在 java.awt.Button 的 HTML 文档中 使用一幅按钮的图片(Button.gif)。首先,你必须把图片文件放到 C:usersrcjavaawtdoc-files 中;然 后在 Button.java 文件中加入下面注释 /** * This button looks like this: * <img src=doc-files/Button.gif> */ " @files 包含文件。为了简化 javadoc 命令,你可以把需要建立文档的文件名和包名放在一个或多个文本 文件中。例如,为了简化下面命令: javadoc -d apidoc com.mypackage1 com.mypackage2 com.mypackage3 你可以建立一个名称为 mypackage.txt 的文件,其内容如下: com.mypackage1 com.mypackage2 com.mypackage3 然后执行下面命令即可: javadoc -d apidoc @mypackage.txt
SDisplay = Hello World ; System.out.println( SDisplay ); } }
使用下面命令: javadoc -private -d doc -author -version myHelloworld.java 即可以生成漂亮的关于 myHelloworld.java 的 API 文档了。 上面例子中以@开头的标记就是 javadoc 标记。在 Java 程序中正确使用 javadoc 标记是一个良好的注释习 惯,将非常有助于 javadoc 自动从源代码文件生成完整的格式化 API 文档。下面就对各种标记进行详细说 明。 ◇ @author name-text 指定生成文档中的作者项,从 JDK/SDK 1.0 开始引入。name-text 可以指定多个名 字(使用,隔开)。文档注释可以包含多个类。 ◇ {@docroot} 代表产生文档的根路径,从 JDK/SDK 1.3 开始引入。用法举例如下 /** *see the <a href={@docroot}/copyright.html>copyright</a> */ 假定生成文档的根目录是 doc,上面注释所在的文件最后生成的文件是 docutilityutl.html,那么 copyright 的链接会指向..copyright.html。 ◇ @deprecated deprecated-text 添加注释,表明不推荐使用该 API。 ◇ @exception class-name description @throw 的同义标记,从 JDK/SDK 1.0 开始引入。 ◇ {@link package.class#member label} 插入指向 package.class#member 的内嵌链接,从 JDK/SDK 1.2 开始引入。举例说明,假定注释中有如下文档: /** Use the {@link #getComponentAt(int, int) getComponentAt} method. */ 那么 javadoc 最终生成的 HTML 页面中将有如下内容 Use the <a href = Component.html#getComponentAt(int,int) > getComponentAt </a> method. ◇ @param parameter-name description 描述参数,从 JDK/SDK 1.0 开始引入。 ◇ @return description 描述返回值,从 JDK/SDK 1.0 开始引入。 ◇ @see reference 添加参见标题,其中有指向 reference 的链接或者文本项,从 JDK/SDK 1.0 开始引入。 @see 标记有三种形式,下面分别说明: (1)、@see string 为 string 添加文本项,不产生链接。 (2)、@see <a href=URL#Value>Label</a> 使用 HTML 标记产生链接 (3)、@see package.class#member Label 使用 Java 语言的名字 package.class #member 产生链接。 ◇ @serial field-description 用于缺省可序列化域的注释,从 JDK/SDK 1.2 开始引入。 ◇ @serialField field-name field-type field-description 建立 Serializable 类的 serialPersistentFields 成员的 ObjectStreamField 组件的文档,从 JDK/SDK 1.2 开始引入。 ◇ @serialData data-description data-description 建立数据序列和类型的文档,从 JDK/SDK 1.2 开始 引入。 ◇ @since since-text 利用 since-text 内容为文档增加 since 标题,从 JDK/SDK 1.1 开始引入。 ◇ @throws class-name description 与@exception 同义。用 class-name 和 description 为输出文档添 加抛出标题,从 JDK/SDK 1.2 开始引入。 ◇ @version version-text 添加版权标题,从 JDK/SDK 1.0 开始引入。 上面介绍了标准 doclet 提供的所有标记。不过,需要注意这些标记的使用是有位置限制的。其中可以出现
" options 命令行选项。javadoc 使用 doclets(doclets 是指用 doclet API 编写的程序。)来确定输出 的内容和格式。命令行选项中一部分是可用于所有 doclet 的通用选项,一部分是由默认的标准 doclet 提 供的专用的选项。下面对各自一些常用的选项分别进行介绍: 通用选项: ◇ -1.1 生成具有 javadoc 1.1 版本生成的文档的外观和功能的文档。不是所有的选项都可以用于-1.1 选 项,具体可以使用 javadoc -1.1 -help 察看。 ◇ -help 显示联机帮助。 ◇ -bootclasspath classpathlist 指定根类(通常是 Java 平台自带的一些类。例如 java.awt.*等)的 路径。 ◇ -sourcepath sourcepathlist 指定包的源文件搜索路径。但是必须注意,只有在 javadoc 命令中指定 了包名的时候才可以使用-sourcepath 选项。如果指定了包名,而省略了-sourcepath,那么 javadoc 使用 类路径查找源文件。举例说明:假定你打算为 com.mypackage 建立文档,其源文件的位置是 C:usersrc。 那么你可以使用下面的命令: javadoc -sourcepath c:usersrc com.mypackage ◇ -classpath classpathlist 指定 javadoc 查找引用类的路径。引用类是指带文档的类加上它们引用的 任何类。javadoc 将搜索指定路径的所有子目录。Classpathlist 可以包含多个路径(使用;隔开)。如果 省略-classpath,则 javadoc 使用-sourcepath 查找源文件和类文件。举例说明:假定你打算为 com.mypackage 建立文档,其源文件的位置是 C:usersrc,包依赖 C:userlib 中的库。那么你可以使用下面 的命令: javadoc -classpath c:userlib -sourcepath c:usersrc com.mypackage ◇ -overview pathfilename 告诉 javadoc 从 pathfilename 所指定的文件中获取概述文档,并且把它放到 输出的概述页面(overview-summary.html)中。其中 pathfilename 是相对于-sourcepath 的相对路径。 ◇ -public 只显示公共类以及成员。 ◇ -protected 只显示受保护的和公共的类以及成员。缺省选项。 ◇ -package 只显示包、受保护的和公共的类以及成员。 ◇ -private 显示所有类和成员。 ◇ -doclet class 指定 javadoc 产生输出内容的自定义 doclet 类。如果忽略这个选项,javadoc 将使用 默认的 doclet 产生一系列 HTML 文档。 ◇ -docletpath classpathlist 与- doclet 选项相关,制定自定义的 doclet 类文件的路径。Classpathlist 可以包含多条路径(用;隔开)。 ◇ -verbose 在 javadoc 运行时提供更详细的信息。 标准 doclet 专用选项: ◇ -author 在生成的文档中包含作者项。 ◇ - d directory 指定 javadoc 保存生成的 HTML 文件的目录。省略该选项将把文件保存在当前目录。 Directory 可以是绝对目录,也可以是相对当前目录的相对目录。 ◇ -version 在生成的文档中包含版本项。 ◇ -use 为类和包生成 use(用法)页面。这些页面描述了该类和包在 javadoc 命令涉及的文件中被使用 的情况。例如:对于给定的类 C,在 C 的用法页面中将包含 C 的子类,类型为 C 的域,返回变量类型为 C 的方法以及在参数中有变量类型为 C 的方法和构造器。 ◇ -splitindex 把索引文件按照字母顺序分为多个文件。每一个文件对应一个字母。 ◇ -windowtitle title 指定输出的 HTML 文档的标题。 ◇ -header header 指定输出的 HTML 文档的页眉文本。 ◇ -footer footer 指定输出的 HTML 文档的脚注文本。
相关文档
最新文档